This repository contains the source for the Tide Book, the book is written in the markdown format and is built using mdbook.
Languages:
The documentation can be edited using any text editor. Most commonly used editors support syntax highlighting for the markdown format. To view your changes you can install the mdbook tool locally, assuming you already have a working Rust setup;
> cargo install mdbookWith mdbook installed you can use it to build and serve the documentation on your local system;
> mdbook servethis will start a local server that will be available on localhost and will automatically build and re-build the documentation when it changes.
Want to help out? Check out our The "Contributing" document
The Tide project adheres to the Contributor Covenant Code of Conduct. This describes the minimum behavior expected from all contributors.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.