Skip to content

Commit 4c0f359

Browse files
committed
Note test dependencies in README
Closes egraphs-good#175
1 parent 1717911 commit 4c0f359

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

.github/workflows/build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ jobs:
1111
with:
1212
path: ~/.cargo/bin
1313
key: ${{ runner.os }}-cargo-bin
14-
- name: Install graphviz and cbc
15-
run: sudo apt-get install graphviz coinor-libcbc-dev
14+
- name: Install cbc
15+
run: sudo apt-get install coinor-libcbc-dev
1616
- name: Test
1717
run: make test
1818
nits:

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,13 @@ Typically, you install Rust using [`rustup`](https://www.rust-lang.org/tools/ins
4949

5050
Run `cargo doc --open` to build and open the documentation in a browser.
5151

52-
Before committing/pushing, make sure to run `make`, which runs all the tests and lints that CI will.
52+
Before committing/pushing, make sure to run `make`,
53+
which runs all the tests and lints that CI will (including those under feature flags).
54+
This requires the [`cbc`](https://projects.coin-or.org/Cbc) solver
55+
due to the `lp` feature.
5356

5457
### Tests
5558

56-
You will need [`graphviz`](https://www.graphviz.org/download/) to run the tests.
5759
Running `cargo test` will run the tests.
5860
Some tests may time out; try `cargo test --release` if that happens.
5961

src/dot.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The [`EGraph::dot`](EGraph::dot()) method creates `Dot`s.
2121
2222
# Example
2323
24-
```
24+
```no_run
2525
use egg::{*, rewrite as rw};
2626
2727
let rules = &[
@@ -38,9 +38,9 @@ println!("My egraph dot file: {}", egraph.dot());
3838
3939
// create a Dot and then compile it assuming `dot` is on the system
4040
egraph.dot().to_svg("target/foo.svg").unwrap();
41-
// egraph.dot().to_png("target/foo.png").unwrap();
42-
// egraph.dot().to_pdf("target/foo.pdf").unwrap();
43-
// egraph.dot().to_dot("target/foo.dot").unwrap();
41+
egraph.dot().to_png("target/foo.png").unwrap();
42+
egraph.dot().to_pdf("target/foo.pdf").unwrap();
43+
egraph.dot().to_dot("target/foo.dot").unwrap();
4444
```
4545
4646
Note that self-edges (from an enode to its containing eclass) will be

src/egraph.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -953,8 +953,6 @@ mod tests {
953953
"union x and y".to_string(),
954954
);
955955
egraph.rebuild();
956-
957-
egraph.dot().to_dot("target/foo.dot").unwrap();
958956
}
959957

960958
#[cfg(all(feature = "serde-1", feature = "serde_json"))]

0 commit comments

Comments
 (0)