Skip to content

stateright/stateright.github.io

Repository files navigation

Building Distributed Systems With Stateright

A book about the Stateright model checker.

You can read the book at stateright.rs.

Repository Layout

  • md-src/ -- The main text of the book.
  • rs-src/ -- Rust code imported by the book.
  • docs/ -- Artifacts built by mdbook.

Instructions

Test the Rust code with cargo:

cargo test

Build the book with Graphviz, Gnuplot, and mdBook using the included script:

./build.sh

You can preview your updates locally with mdbook serve, but remember to rebuild before preparing your commit:

mdbook serve # Iterate with "serve"
^C           # ... then ctrl-C to quit
./build.sh   # ... and rebuild.
git commit

Pull requests are welcome. Currently the repository includes the built artifacts, so those can be included in pull requests.