Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
richrobe committed Jun 12, 2023
1 parent 584142a commit a7d3b6e
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,20 +186,26 @@ To be added
### Command Line Interface

For the preparation steps, `carwatch` also provides a CLI for more convenient usage.
Make sure you installed the `carwatch` package with `pip install carwatch`. After that, you can simply run the preparation CLI by running
Make sure you installed the `carwatch` package with `pip install carwatch`.

After that, you can simply run the TUI (terminal user interface) by running
```
prepare_study
prepare_study tui
```
in a terminal session.

This will implicitly run the `scripts/prepare_study.py` script, which will guide you through the preparation steps.
You will then be prompted to enter all the required information step-by-step. The desired output files will
be automatically generated for you.

For more information about the prompted commands please run:
The regular command line interface (CLI) can be used by running
```
prepare_study run
```

For more information about the prompted commands please run:
```
prepare_study --help
prepare_study run --help
```

## License
Expand Down

0 comments on commit a7d3b6e

Please sign in to comment.