* program keys * cleanup * update * missing SUMMARY * review comments * fixed @jackmay comment * update to take a user base address * rename |
||
---|---|---|
.. | ||
art | ||
src | ||
theme | ||
.gitattributes | ||
README.md | ||
book.toml | ||
build-cli-usage.sh | ||
build.sh | ||
makefile | ||
offline-cmd-md-links.sh | ||
set-solana-release-tag.sh |
README.md
Building the Solana Docs
Install dependencies, build, and test the docs:
$ brew install coreutils
$ cargo install svgbob_cli
$ brew install mscgen
$ brew install mdbook
$ ./build.sh
Run any Rust tests in the markdown:
$ make test
Render markdown as HTML:
$ make build
Render and view the docs:
$ make open