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

1.4 KiB
Raw Blame History

peach-devdocs

Build Status

Developer documentation for PeachCloud in the form of a Markdown book.

Read online here >> 📖

🚧 TODO - find a nice place to publish this online! 🚧

PeachCloud physical interface

Development

Dependencies:

  • mdBook (release binaries or cargo install)
$ git clone https://github.com/peachcloud/peach-devdocs
$ cd peach-devdocs
$ mdbook serve

This serves the current state of the book at localhost:3000. When changes to any files are saved, the browser view will automatically refresh to reflect the new state.

NOTES:

  • this assumes mdbook is in your PATH
    • the command for adding the default cargo bin directory is export PATH=$PATH:~/.cargo/bin.
    • if you downloaded the prebuilt binary then make sure the directory is in your PATH

Build a release

$ mdbook serve

This builds the book into a static release ready for publishing. Currently outputs to book/ directory.

🚧 TODO - describe how and where this is published / hosted 🚧

Licensing

AGPL-3.0