The Parsec Book 📖

This repository is the source code of https://parallaxsecond.github.io/parsec-book

Using

You can also build the book and read it locally with the following steps:

$ git clone https://github.com/parallaxsecond/parsec-book.git
$ cd parsec-book
$ cargo install mdbook
$ mdbook serve

This book uses the Versioned Markdown format which allows us to use the vmdfmt formatting tool. The lines should be wrapped after 100 characters. If you have the vmdfmt command available on the command-line,

vmdfmt -cols 100 -w -l src/

will format in-place all the markdown files in your current directory, and

$ ./ci/check_format.sh

will check if your files are formatted correctly.

Contributing

Please check the Contribution Guidelines to know more about the contribution process.

License

This book is provided under Apache-2.0. Contributions to this project are accepted under the same license.