Skip to content

Commit 2c82bb3

Browse files
committed
Extra info on installing tooling
1 parent 7a02c7b commit 2c82bb3

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,32 @@ The public corpus links for each target should be accessible here:
5050

5151
Check out [REPRODUCING.md](REPRODUCING.md) for more detailed instructions.
5252

53+
## How do I install the Python tooling?
54+
55+
- Create a virtual environment using your favourite method.
56+
- For example:
57+
```shell
58+
python3 -m venv .venv
59+
```
60+
- Within that virtual environment, from the root directory of this repository, install the tooling with `pip install .`
61+
62+
Alternatively you can use Poetry to run tools directly, using `poetry run <tool>`.
63+
5364
## What's in this testcase?
5465

5566
To look at the contents of a testcase, run
5667
```shell
57-
poetry run read_corpus <path/to/file>
68+
read_corpus <path/to/file>
5869
```
5970
This will print out a list of contents inside the file.
6071

6172
## I want to generate a new testcase
6273

6374
To generate a new testcase, run
6475
```shell
65-
poetry run generate_corpus
76+
generate_corpus
6677
```
67-
with appropriate options.
78+
with appropriate options - pass `--help` for all options.
6879

6980
# I want to enhance the fuzzer!
7081

0 commit comments

Comments
 (0)