diff --git a/README.md b/README.md index ce5b9e0..d8d3820 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,44 @@ # peach-devdocs -Developer documentation for PeachCloud in the form of a Markdown book. +Developer documentation for [PeachCloud](https://github.com/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._ +## [Read online here >> :book:](https://mixmix.github.io/peach-devdocs) -### Quickstart +:construction: _TODO - find a nice place to publish this online!_ :construction: -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 read the documentation from there. +![peachloud interface](./src/assets/peachcloud.jpg) -### Setup +## Development -[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): +Dependencies: +- [mdBook](https://github.com/rust-lang/mdBook) (release binaries or cargo install) -`cargo install mdbook` +```bash +$ git clone https://github.com/peachcloud/peach-devdocs +$ cd peach-devdocs +$ mdbook serve +``` -Once mdBook is installed, clone this repo: +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. -`git clone https://github.com/peachcloud/peach-devdocs` +**NOTES**: +- this assumes `mdbook` is in you `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 it's in is in your `PATH` -Move into the repo, add the Cargo bin directory to your `PATH`, build and serve: -`cd peach-devdocs` -`export PATH=$PATH:~/.cargo/bin` -`mdbook build` -`mdbook serve` +## Build a release + +``` +$ 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: -The book is served on `localhost:3000` by default and refreshes automatically in-browser when changes to the documentation are saved. ### Licensing diff --git a/src/assets/peachcloud.jpg b/src/assets/peachcloud.jpg new file mode 100644 index 0000000..9d91fb1 Binary files /dev/null and b/src/assets/peachcloud.jpg differ diff --git a/src/chapter_1.md b/src/chapter_1.md index 497a6cd..f6e13b3 100644 --- a/src/chapter_1.md +++ b/src/chapter_1.md @@ -1,3 +1,5 @@ # Introduction PeachCloud is a low-power, lightweight hardware device designed to facilitate peer-to-peer communication across social networks. We aim to return (cloud) computing back into our homes and local communities in a way which fosters increased trust in one another and the socio-technical systems we inhabit. + +![peachcloud screen/ interface](./assets/peachcloud.jpg)