# Lighthouse Book

Contains an [mdBook](https://github.com/rust-lang-nursery/mdBook) that serves
as the primary source of Lighthouse user documentation.

The book is hosted at [lighthouse-book.sigmaprime.io](http://lighthouse-book.sigmaprime.io).

## Usage

The [mdBook docs](https://github.com/rust-lang-nursery/mdBook#usage) are the
best source of information for building the book.

### Example

1. Install mdBook: `$ cargo install mdbook`
1. Build the book, open it in a browser and build after file changes: `$ mdbook
   watch --open`