PeachCloud
/
peach-devdocs
0
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity
Developer documentation for PeachCloud in the form of a Markdown book.
20 Commits 1 Branch 0 Tags 461 KiB
JavaScript 41.6%
CSS 33.4%
Handlebars 25%
Go to file
mycognosist f236b97cc9 Add basic Debian packaging info 2020-05-14 14:57:56 +01:00
src Add basic Debian packaging info 2020-05-14 14:57:56 +01:00
.gitignore Change file naming to semantic descriptions using directories 2019-11-11 08:39:07 +00:00
README.md Fix typos 2019-11-11 08:43:14 +00:00
book.toml Initial commit with draft chapter outline 2019-10-14 19:01:25 +01:00
notes Initial commit with draft chapter outline 2019-10-14 19:01:25 +01:00

README.md

peach-devdocs

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