Skip to content

docs: clarify deterministic quick start requirements - #7

Merged
rustfuture merged 1 commit into
mainfrom
docs/quickstart-usability
Oct 2, 2026
Merged

rustfuture merged 1 commit into
mainfrom
docs/quickstart-usability

Conversation

@rustfuture

Copy link
Copy Markdown
Owner

State the Python requirement, use python3 explicitly and explain where the deterministic run writes its summary and report. Add Windows command/path guidance while keeping the first run free of optional model dependencies.

Validation

All listed checks completed locally with exit code 0. Run output paths used temporary directories to preserve committed evidence.

git diff --check
python3 -m rsi_framework --config config/default.json --output /var/folders/v1/5g8zpd5j0h56kyw4dn14f_g40000gn/T/portfolio-quickstart-c03_zqaj/rsi-run
python3 -m unittest discover -s tests
python3 -m rsi_framework.reporting --results results --readme README.md --check

Tested on macOS with Python 3.14.5; Windows and the optional model path were not run.

@rustfuture
rustfuture merged commit 04fa867 into main Oct 2, 2026
1 check passed
@rustfuture
rustfuture deleted the docs/quickstart-usability branch October 2, 2026 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant