2019-10-30 15:10:57 +00:00
|
|
|
# peach-devdocs
|
|
|
|
|
|
2020-05-18 09:29:58 +00:00
|
|
|
[](https://travis-ci.com/peachcloud/peach-devdocs)
|
|
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
Developer documentation for [PeachCloud](https://github.com/peachcloud) in the form of a Markdown book.
|
2019-10-30 15:10:57 +00:00
|
|
|
|
2019-11-09 08:24:26 +00:00
|
|
|
## [Read online here >> :book:](https://mixmix.github.io/peach-devdocs)
|
2019-10-30 15:22:23 +00:00
|
|
|
|
2019-11-09 08:03:04 +00:00
|
|
|
:construction: _TODO - find a nice place to publish this online!_ :construction:
|
2019-10-30 15:22:23 +00:00
|
|
|
|
2019-11-11 08:43:14 +00:00
|
|
|
|
2019-11-09 08:22:02 +00:00
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
## Development
|
2019-10-30 15:22:23 +00:00
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
Dependencies:
|
|
|
|
|
- [mdBook](https://github.com/rust-lang/mdBook) (release binaries or cargo install)
|
2019-10-30 15:10:57 +00:00
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
```bash
|
|
|
|
|
$ git clone https://github.com/peachcloud/peach-devdocs
|
|
|
|
|
$ cd peach-devdocs
|
|
|
|
|
$ mdbook serve
|
|
|
|
|
```
|
2019-10-30 15:10:57 +00:00
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
This serves the current state of the book at [localhost:3000](http://localhost:3000).
|
|
|
|
|
When changes to any files are saved, the browser view will automatically refresh to reflect the new state.
|
2019-10-30 15:10:57 +00:00
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
**NOTES**:
|
2019-11-11 08:43:14 +00:00
|
|
|
- this assumes `mdbook` is in your `PATH`
|
2019-11-09 07:48:00 +00:00
|
|
|
- the command for adding the default cargo bin directory is `export PATH=$PATH:~/.cargo/bin`.
|
2019-11-11 08:43:14 +00:00
|
|
|
- if you downloaded the prebuilt binary then make sure the directory is in your `PATH`
|
2019-10-30 15:10:57 +00:00
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
## Build a release
|
2019-10-30 15:10:57 +00:00
|
|
|
|
2019-11-09 07:48:00 +00:00
|
|
|
```
|
|
|
|
|
$ mdbook serve
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This builds the book into a static release ready for publishing.
|
|
|
|
|
Currently outputs to `book/` directory.
|
|
|
|
|
|
|
|
|
|
:construction: _TODO - describe how and where this is published / hosted_ :construction:
|
2019-10-30 15:10:57 +00:00
|
|
|
|
|
|
|
|
### Licensing
|
|
|
|
|
|
|
|
|
|
AGPL-3.0
|
