Skip to content

Commit 52d2108

Browse files
committed
README update
1 parent 93d85da commit 52d2108

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,16 @@
1010

1111
Provide a Python API for [WRENCH](https://wrench-project.org). This API is built on top of WRENCH's [REST API](https://wrench-project.org/wrench/latest/rest_api.html).
1212

13-
# Dependencies and Installation
13+
# Dependencies
1414

1515
- [WRENCH](https://github.com/wrench-project/wrench) master branch and its dependencies
1616
- You must compile the `wrench-daemon` target (i.e., `make wrench-daemon`) during the build process before doing the usual (`sudo make install`)
17-
- Run `python3 -m build` to build the package (you may need to install the `build` Python package).
18-
- Run `python3 -m pip install ./dist/wrench-*.whl` to install the package
1917

20-
# Examples and API Documentation
18+
# Installation
19+
20+
A simple `pip install .` should do.
21+
22+
# Examples and Documentation
2123

2224
Example simulators are provided in the `examples` directory. See the `README` file therein for information on what these examples are and how to run them.
2325

0 commit comments

Comments
 (0)