Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

My comments #75

Draft
wants to merge 8 commits into
base: active
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions DEV_SETUP.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@

--> This is a lot of space about setting up commit signing, which isn't
strictly necessary. I'd recommend moving this info elsewhere.

# Setting up git

First, you'll need to set up commit signing.
Expand All @@ -13,6 +16,11 @@ brew install gpg
git config --global commit.gpgsign true
```

--> gpg probably isn't considered best practices anymore. GPG had its day, and
those days are mostly over. Github supports ssh signing, and I think that's
probably a better thing since everyone needs ssh anyway and not everyone needs
gpg. Use `age` instead of gpg for encryption.

## Find the verified email address for your GitHub account here:
https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address

Expand Down Expand Up @@ -60,10 +68,19 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Set the rust compiler to the bleeding edge, so we can use certain libraries
rustup toolchain install nightly
rustup default nightly
# rustup default nightly
^^^^^^^^^^^^^^^^^^^^^^^^ <-- don't do this. It's global and affects everything,
and could very much confuse the user. If you need nightly, say so in your
`rust-toolchain.toml` file in the root of your directory. See
https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file

Also, state explicitly what features of nightly you need, probably as comments
in the .toml file. The goal is to eventually move to stable once all the
features from nightly you need have migrated to stable. Using nightly makes it
much harder to build reproducible builds
```

## Check the build
```bash
cargo test
```
```
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@

```
This is a good doc, but it's not a `README`. The `README.md` is displayed
as the intro page to the repo on GitHub, and it should be a high-level
overview of the project. This doc is more of an overview of the types and
traits used in the project, which is great, but it should be moved to
say, "OVERVIEW.md" or something like that.

ChatGPT can write a `README` for you. I glued in soem stuff github
copilot wrote for me:

```
# Chia Gaming

## Introduction

Chia Gaming is a Rust-based project focused on implementing gaming mechanics and state channels on the Chia blockchain. This repository hosts the traits, structs, and modules necessary for creating and managing games on the Chia network.

## Features

- Rust-based implementation
- Comprehensive set of traits and structs for gaming mechanics
- Support for state channels on the Chia blockchain
- Example games and modules

## Key Components

## chia-gaming Traits and Structs

Here's a breakdown of the key traits and structs used in the `chia-gaming` project, along with their purposes.
Here's a breakdown of the key traits and structs used in the `chia-gaming` project.

**Common Types:**

Expand Down
9 changes: 9 additions & 0 deletions clsp/NOTE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
One very likely user of this code will be third parties who want to implement games. To make this code as reusable as possible for these users, separate game-specific code from generic refereee etc. code. Maybe something like:

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ya, we should finally move calpoker into its own directory and isolate each.


clsp
├── examples
│   ├── calpoker
│   ├── krunk
│   └── space_poker
└── gaming
2 changes: 2 additions & 0 deletions rust-toolchain.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[toolchain]
channel = "nightly"
Loading
Loading