Skip to content

Commit

Permalink
Add Installation section to README
Browse files Browse the repository at this point in the history
Signed-off-by: Colin Wilk <[email protected]>
  • Loading branch information
kliwniloc committed Jun 18, 2024
1 parent 0d93d75 commit 946cca6
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,30 @@ that:
docker run --rm -it -v /my-conf.ini:$(pwd)/my-conf.ini ghcr.io/ls1intum/storage-benchmarking run -d /tmp -c /my-conf.ini
```

## Installation
To run the project locally clone it first:
```sh
git clone https://github.com/ls1intum/storage-benchmarking
cd storage-benchmarking
```

Then install the dependencies using [Poetry](https://python-poetry.org/)
(you can install poetry with pip: `pip install poetry`).
```sh
poetry install --no-dev
```

Make sure you have fio installed and in your `PATH`;
```sh
$ fio -v
fio-3.37
```

Then you can run the project as described in the Usage section with
```sh
poetry run python3 src/benchmarking_tool/main.py
```

## License
The project is licensed under MIT, see the LICENSE for more information.

Expand Down

0 comments on commit 946cca6

Please sign in to comment.