openrr/openrr-tutorial

openrr-tutorial

Books

You can read the book at the following links.

• English: https://openrr.github.io/openrr-tutorial/en/html

• Japanese: https://openrr.github.io/openrr-tutorial/ja/html

Requirements

Building the book requires mdBook, you can install it using cargo.

cargo install mdbook

Building

To build the book:

mdbook build docs/en

Development

While writing it can be handy to see your changes, mdbook serve will launch a local web server to serve the book.

mdbook serve docs/en --open

Spell check

Using cspell

Installation of cspell

npm install -g cspell

Spell checking

cspell -c ./cspell.json  "docs/{en,ja}/src/**"

Extension

In VScode, You can use Code Spell Checker to check spelling without executing the above command.