Skip to content

Commit 946cca6

Browse files
committed
Add Installation section to README
Signed-off-by: Colin Wilk <[email protected]>
1 parent 0d93d75 commit 946cca6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,30 @@ that:
131131
docker run --rm -it -v /my-conf.ini:$(pwd)/my-conf.ini ghcr.io/ls1intum/storage-benchmarking run -d /tmp -c /my-conf.ini
132132
```
133133

134+
## Installation
135+
To run the project locally clone it first:
136+
```sh
137+
git clone https://github.com/ls1intum/storage-benchmarking
138+
cd storage-benchmarking
139+
```
140+
141+
Then install the dependencies using [Poetry](https://python-poetry.org/)
142+
(you can install poetry with pip: `pip install poetry`).
143+
```sh
144+
poetry install --no-dev
145+
```
146+
147+
Make sure you have fio installed and in your `PATH`;
148+
```sh
149+
$ fio -v
150+
fio-3.37
151+
```
152+
153+
Then you can run the project as described in the Usage section with
154+
```sh
155+
poetry run python3 src/benchmarking_tool/main.py
156+
```
157+
134158
## License
135159
The project is licensed under MIT, see the LICENSE for more information.
136160

0 commit comments

Comments
 (0)