Skip to content

Commit 7dde401

Browse files
docs: readme updated to newer version, contains legacy folder
readme updated to newer version which contains legacy folder
1 parent 3c0657a commit 7dde401

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,11 @@ python -m quant_research_starter.cli compute-factors -d data_sample/sample_price
9494
# run a backtest
9595
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
9696

97-
# optional: start the Streamlit dashboard
97+
# DISCLAIMER: OLD VERSION
98+
# optional: start the Streamlit dashboard, if on main stream
9899
streamlit run src/quant_research_starter/dashboard/streamlit_app.py
100+
# NEW VERSION: if streamlit is in legacy folder
101+
streamlit run legacy/streamlit/streamlit_app.py
99102
```
100103

101104
---

0 commit comments

Comments
 (0)