https://nnethercote.github.io/perf-book/
The Rust Performance Book
https://nnethercote.github.io/perf-book/
Last synced: about 1 year ago
JSON representation
The Rust Performance Book
- Host: GitHub
- URL: https://nnethercote.github.io/perf-book/
- Owner: nnethercote
- License: apache-2.0
- Created: 2020-11-17T01:28:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-28T04:17:12.000Z (over 1 year ago)
- Last Synced: 2025-04-16T16:49:27.800Z (about 1 year ago)
- Size: 2.43 MB
- Stars: 2,395
- Watchers: 46
- Forks: 114
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-rust-with-stars - The Rust Performance Book - | (Resources / Web programming)
- awesome-basics - The Rust Performance Book
- links - The Rust Performance Book
- awesome-rust - The Rust Performance Book - Tips for optimizing Rust programs (Resources / Web programming)
README
# perf-book
The Rust Performance Book.
## Viewing
The rendered (HTML) book is [here](https://nnethercote.github.io/perf-book/).
## Building
The book is built with [`mdbook`](https://github.com/rust-lang/mdBook), which
can be installed with this command:
```
cargo install mdbook
```
To build the book, run this command:
```
mdbook build
```
The generated files are put in the `book/` directory.
## Development
To view the built book, run this command:
```
mdbook serve
```
This will launch a local web server to serve the book. View the built book by
navigating to `localhost:3000` in a web browser. While the web server is
running, the rendered book will automatically update if the book's files
change.
To test the code within the book, run this command:
```
mdbook test
```
## Improvements
Suggestions for improvements are welcome, but I prefer them to be filed as
issues rather than pull requests. This is because I am very particular about
the wording used in the book. When pull requests are made, I typically take the
underlying idea of a pull request and rewrite it into my own words anyway.
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.