Skip to content

Commit

Permalink
fix: some clarification in the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oversize committed Jun 4, 2024
1 parent 3d47228 commit 80853d8
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ up to you, its just a python package after all.
```bash
# Create the folder you want blockperf to live in
# cd into it and clone the repo
mkdir -p /opt/blockperf
cd /opt/blockperf
git clone git@github.com:cardano-foundation/blockperf.git .
mkdir -p ~/blockperf
cd ~/blockperf
git clone https://github.com/cardano-foundation/blockperf.git .

# Create a venv and activate it.
python3 -m venv .venv
Expand All @@ -80,14 +80,6 @@ blockperf --help
> blockperf. See docs if you are new to virtual environments:
> <https://docs.python.org/3/tutorial/venv.html>
**Test your installation**

```bash
# Remember to activate the virtual environment if not in the same shell as above
# source .venv/bin/activate
blockperf run
```

## Configuration of blockperf

To configure blockperf configure the following environment variables
Expand Down Expand Up @@ -140,6 +132,16 @@ KillSignal=SIGINT
SyslogIdentifier=blockperf
TimeoutStopSec=5
```
## Run Blockperf

Once you have configured the environment variables you should be able to
run blockperf.

```bash
# Remember to activate the virtual environment if not in the same shell as above
# source .venv/bin/activate
blockperf run
```

## Development

Expand Down

0 comments on commit 80853d8

Please sign in to comment.