Skip to content

Commit

Permalink
Add dev environment setup doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
aqk committed Oct 31, 2024
1 parent c2ae9f7 commit 4f95ff4
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions DEV_SETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@

# Setting up git

First, you'll need to set up commit signing.


`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:
https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address

# 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

# Get the ID for your GPG secret key
# In the example below, it is '3AA5C34371567BD2'

$ gpg --list-secret-keys --keyid-format=long
/Users/<you>/.gnupg/secring.gpg
------------------------------------
sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
uid You <[email protected]>
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
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
`

## Install Rust
`
brew install llvm maturin
rustup toolchain install nightly
rustup default nightly
`

## Check the build
`cargo test
`

0 comments on commit 4f95ff4

Please sign in to comment.