Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nnethercote/perf-book
The Rust Performance Book
https://github.com/nnethercote/perf-book
Last synced: 26 days ago
JSON representation
The Rust Performance Book
- Host: GitHub
- URL: https://github.com/nnethercote/perf-book
- Owner: nnethercote
- License: apache-2.0
- Created: 2020-11-17T01:28:44.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-05T23:40:44.000Z (6 months ago)
- Last Synced: 2024-05-22T08:06:40.471Z (6 months ago)
- Size: 2.4 MB
- Stars: 2,218
- Watchers: 45
- Forks: 105
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - perf-book
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.