diff --git a/README.md b/README.md index 9bbfd5a..578c3e3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,29 @@ _Solving satisfiability problems in Rust_ +## Installation + +1) Make sure to install the [Rust toolchain](https://www.rust-lang.org/tools/install). + +2) Clone the latest version of this repository: +``` +$ git clone git@github.com:timbeurskens/rsbdd.git +``` + +3) Build and install the RsBDD tools: +``` +$ cd rsbdd +$ cargo install --bins --path . +``` + +The following tools will be available after installing the RsBDD package: + +- `max_clique_gen` +- `n_queens_gen` +- `random_graph_gen` +- `rsbdd` +- `sudoku_gen` + ## Syntax ### Comments