Skip to content

Commit

Permalink
Merge pull request #123 from georgkrause/fix-readme
Browse files Browse the repository at this point in the history
docs: Fix commands to run troi in development environment
  • Loading branch information
mayhem authored Jan 25, 2024
2 parents b91c10b + e84f5be commit c12b5a5
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ below.
virtualenv -p python3 .ve
source .ve/bin/activate
pip3 install .[tests]
python3 troi --help
troi --help
```

**Windows**
Expand All @@ -48,22 +48,22 @@ python3 troi --help
virtualenv -p python .ve
.ve\Scripts\activate.bat
pip install .[tests]
python troi --help
troi --help
```

## Basic commands

List available patches:

python troi list
troi list

Generate a playlist using a patch:

python troi playlist --print [patch-name]
troi playlist --print [patch-name]

If the patch requires arguments, running it with no arguments will print a usage statement, e.g.

$ python troi playlist --print area-random-recordings
$ troi playlist --print area-random-recordings
Usage: area-random-recordings [OPTIONS] AREA START_YEAR END_YEAR

Generate a list of random recordings from a given area.
Expand All @@ -78,9 +78,9 @@ If the patch requires arguments, running it with no arguments will print a usage
## Running tests

```
python3 troi test
python3 troi test -v
python3 troi test -v <file to test>
troi test
troi test -v
troi test -v <file to test>
```

## Building Documentation
Expand Down

0 comments on commit c12b5a5

Please sign in to comment.