Skip to content

Commit

Permalink
add installation instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Beurskens committed Jun 20, 2022
1 parent e813df6 commit 7da47f0
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]: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
Expand Down

0 comments on commit 7da47f0

Please sign in to comment.