Skip to content

Commit 229da25

Browse files
committed
Update flake use
1 parent b881384 commit 229da25

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
# BreakID
22
A new symmetry detecting and breaking library. This is based on Jo Devriendt's [BreakID code](https://bitbucket.org/krr/breakid/src/master/). It has been re-licensed by the original author to be MIT and hence it's realeased as MIT here. All modifications by Mate Soos.
33

4+
## Compiling
45

5-
## Compile & Run
6+
Use of the [release binaries](https://github.com/meelgroup/ganak/releases) is
7+
encouraged. The second best thing to use is Nix. Simply [install
8+
nix](https://nixos.org/download/) and then:
9+
```shell
10+
nix profile install github:meelgroup/breakid
11+
```
12+
13+
Then you will have `breakid` binary available and ready to use. Otherwise,
14+
you can compile the code yourself via:
615

716
```bash
817
git clone https://github.com/meelgroup/breakid
@@ -12,10 +21,12 @@ cmake ..
1221
make
1322
```
1423

24+
## Running BreakID
25+
1526
BreakID detects symmetries in your input CNF file and creates a new CNF file
1627
that has your original CNF in it, along with some new variables and clauses
1728
that help break most symmetries:
18-
29+
1930
```bash
2031
./breakid myfile.cnf symmetry-broken-output.cnf
2132
c BreakID version [...]

0 commit comments

Comments
 (0)