Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,25 @@ See the [rendered book](https://lborb.github.io/book/).
## Development

Install [`mdbook`](https://github.com/rust-lang/mdBook):
```

```console
cargo install mdbook
```

Build the book:
```

```console
mdbook build
```

The generated files are in the `book` directory.

View the built book:
```

```console
mdbook serve
```

This will launch a local web server to serve the book. Navigate to
[localhost:3000](http://localhost:3000/) in a web browser. While the web server
is running, the rendered book will automatically update if the source files
Expand All @@ -35,10 +40,17 @@ change.
### Conventions

Each entry is of the form:
```

```markdown
* [The Literal Title of The Book](https://a-link-to-the/book/) - an optional comment if the title isn't self-explanatory
```

Entries for items in formats other than mdbook are italicised, like this:

```markdown
* [_The Literal Title of The Item_](https://a-link-to-the/book/) - an optional comment if the title isn't self-explanatory
```

The `.editorconfig` file captures basic source files formatting conventions.
Many editors support this file natively; others (such as VS code) require a plugin, see https://editorconfig.org/.

Expand Down