Skip to content

docs: document required git submodule init step #8

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.

Sign up for GitHub

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

Open
ygd58 wants to merge 1 commit into
base: mainnet-beta
Choose a base branch
from
Open

docs: document required git submodule init step #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@
- modern rust version
- bun

## Getting started

This repo uses git submodules (`psy-genesis`, `psy-contracts`, `psy-dapp`).
`psy-genesis` in particular is required at build time (`psy_config`'s
`build.rs` reads `psy-genesis/config.json`), so `cargo build` will fail on a
fresh clone unless submodules are initialized:

```bash
git clone https://github.com/PsyProtocol/psy-node.git
cd psy-node
git submodule update --init --recursive
```

### Spinning up a local development cluster
```bash
Expand Down