cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
c5722093d3
lighthouse/book
History
Michael Sproul c5722093d3 Clarify lack of Windows support (#1453) 
## Issue Addressed

Replaces and closes #1446

## Proposed Changes

Clarify that Windows is only supported via WSL in the docs.
2020-08-04 06:20:07 +00:00
..
src Clarify lack of Windows support (#1453) 2020-08-04 06:20:07 +00:00
.gitignore Add newly created mdbook 2019-09-01 11:31:18 +10:00
book.toml Update HTTP API docs (#1010) 2020-04-16 20:31:43 +10:00
README.md Update HTTP API docs (#1010) 2020-04-16 20:31:43 +10:00

README.md

Lighthouse Book

Contains an mdBook that serves as the primary source of Lighthouse user documentation.

The book is hosted at lighthouse-book.sigmaprime.io

Usage

The mdBook docs are the best source of information for building the book.

Example

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