https://github.com/openrr/openrr-tutorial

https://github.com/openrr/openrr-tutorial

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/openrr/openrr-tutorial
• Owner: openrr
• License: apache-2.0
• Created: 2022-08-03T08:33:09.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-29T01:17:34.000Z (over 1 year ago)
• Last Synced: 2025-05-30T18:06:34.150Z (about 1 year ago)
• Homepage:
• Size: 3.32 MB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# openrr-tutorial

[![crates.io](https://img.shields.io/crates/v/openrr.svg?logo=rust)](https://crates.io/crates/openrr) [![docs](https://docs.rs/openrr/badge.svg)](https://docs.rs/openrr) [![discord](https://dcbadge.vercel.app/api/server/8DAFFKc88B?style=flat)](https://discord.gg/8DAFFKc88B)

## 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](https://github.com/rust-lang/mdBook), you can install it using cargo.

```bash

cargo install mdbook

```

## Building

To build the book:

```bash

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.

```bash

mdbook serve docs/en --open

```

## Spell check

Using cspell

### Installation of `cspell`

```bash

npm install -g cspell

```

### Spell checking

```bash

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

```

### Extension

In VScode, You can use [`Code Spell Checker`](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) to check spelling without executing the above command.