PeachCloud/peach-devdocs
0
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Add quickstart note

Browse Source
This commit is contained in:
mycognosist
2019-10-30 15:22:23 +00:00
parent 86780d1da1
commit 3beaf2b8bc
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -2,6 +2,12 @@
Developer documentation for PeachCloud in the form of a Markdown book. Developer documentation for PeachCloud in the form of a Markdown book.
_Note: the book is not yet available in built form online. A link will be included in this repo when that is the case._
### Quickstart
If you do not wish to build and serve the book locally, simply navigate to the [src/SUMMARY.md](https://github.com/peachcloud/peach-devdocs/blob/master/src/SUMMARY.md) file on the GitHub repo and navigate the documentation from there.
### Setup ### Setup
[mdBook](https://github.com/rust-lang/mdBook) is required to build and serve the book locally. Installation can be achieved via the [release binaries](https://github.com/rust-lang/mdBook/releases) or directly via Cargo (assuming you have Rust version 1.35 or higher and Cargo installed): [mdBook](https://github.com/rust-lang/mdBook) is required to build and serve the book locally. Installation can be achieved via the [release binaries](https://github.com/rust-lang/mdBook/releases) or directly via Cargo (assuming you have Rust version 1.35 or higher and Cargo installed):