solana-with-rpc-optimizations/docs
Greg Fitzgerald f671be814e
Move bench-tps instructions (#8734)
automerge
2020-03-09 15:26:03 -07:00
..
art Add retransmit_stage diagram (#8645) 2020-03-05 10:12:02 -08:00
src Move bench-tps instructions (#8734) 2020-03-09 15:26:03 -07:00
theme
.gitattributes
README.md
book.toml
build-cli-usage.sh Prevent trailing space in CLI usage docs generation (#8578) 2020-03-02 16:37:38 -08:00
build.sh
makefile Generate CLI usage (#8637) 2020-03-04 17:44:30 -07:00
offline-cmd-md-links.sh Docs: Update CLI offline cmds (#8548) 2020-03-01 17:20:37 -07:00

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