Skip to content

Commit

Permalink
Clean up markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
aqk committed Oct 31, 2024
1 parent 4f95ff4 commit 4e5d801
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions DEV_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@
First, you'll need to set up commit signing.


`bash
```bash

# install gpg on macos
brew install gpg

# Set git to sign all commits by default
git config --global commit.gpgsign true
```

# Find the verified email address for your GitHub account here:
## 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

```bash
# Create a new gpg key -- make sure to use you verified github email
gpg --full-generate-key
# https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key
Expand All @@ -31,30 +33,37 @@ ssb 4096R/4BB6D45482678BE3 2016-03-10

# Print the GPG public key in ASCII armor format
gpg --armor --export <YOUR_ID e.g. 3AA5C34371567BD2>

# Add your GPG signing key to your github account
```
## Add your GPG signing key to your github account
https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account#adding-a-gpg-key
`


# Setting up your development environment

Now that you have git signing set up, let's set up the repo.

## Check out the repo

`bash
$ cd
$ git clone [email protected]:Chia-Network/chia-gaming.git
$ cd chia-gaming
`
```bash
cd
git clone [email protected]:Chia-Network/chia-gaming.git
cd chia-gaming
```

## Install Rust
`
brew install llvm maturin
```bash
# If you have the brew-installed tools, remove them
brew remove llvm maturin

# Install rust
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
`
```

## Check the build
`cargo test
`
```bash
cargo test
```

0 comments on commit 4e5d801

Please sign in to comment.