Skip to content

Commit badb979

Browse files
chore: update readme with new command syntax and paths
1 parent 83f8e31 commit badb979

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ After installation, you can use the CLI in two ways:
6060
**Option 1: Direct command (if PATH is configured)**
6161
```bash
6262
qrs --help
63-
qrs generate-data -o data/sample.csv -s 5 -d 365
64-
qrs compute-factors -d data/sample.csv -f momentum -f value
63+
python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365
64+
python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
6565
qrs backtest -d data/sample.csv -s output/factors.csv
6666
```
6767

@@ -70,7 +70,7 @@ qrs backtest -d data/sample.csv -s output/factors.csv
7070
python -m quant_research_starter.cli --help
7171
python -m quant_research_starter.cli generate-data -o data/sample.csv -s 5 -d 365
7272
python -m quant_research_starter.cli compute-factors -d data/sample.csv -f momentum -f value
73-
python -m quant_research_starter.cli backtest -d data/sample.csv -s output/factors.csv
73+
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
7474
```
7575

7676
### Demo (one-line)

0 commit comments

Comments
 (0)