9aedb12bfc
* Refactor documentation, ef_tests makefile * Add makefile to root * Tidy readme * Fix readme badges * Tidy logs * Add terminalize gif * Update readme image * Update readme image * Tidy logs * Update readme image * Update readme * Update readme * Fix book link * Update makefiles * Update book * Fix link in book * Add readme for book * Remove old docs, move api spec YAML * Fix eth2/ dir readme * Add readme for lcli * Add about this book section * Minor formatting improvements * Address mehdi's comments
18 lines
540 B
Markdown
18 lines
540 B
Markdown
# 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`
|