Skip to content

Commit

Permalink
Merge pull request rust-cli#236 from stomar/building-the-book
Browse files Browse the repository at this point in the history
Add instructions on how to build the book
  • Loading branch information
pksunkara committed Nov 13, 2023
2 parents 3215f97 + cbf8db5 commit c35663f
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,32 @@
This repo contains the CLAiR, the [Command Line Applications in Rust][clair] book.
It is written and updated by the [Rust CLI working group][wg].

## Building

Building the book requires [mdBook].
To get it:

[mdBook]: https://github.com/rust-lang/mdBook

```bash
$ cargo install mdbook
```

To build the book, type:

```bash
$ mdbook build
```

The output will be in the `book` subdirectory.
To check it out, open `book/index.html` in your web browser.

To run the tests:

```bash
$ mdbook test
```

## Multi-language support
Unofficial translation:
- 中文(zh_CN):[Rust 中的命令行应用][rust-cli-zh_CN] (2021-09-13)
Expand Down

0 comments on commit c35663f

Please sign in to comment.