docs: add project README and MIT license - #2
Merged
Merged
Conversation
AaronL725
marked this pull request as ready for review
July 16, 2026 18:39
There was a problem hiding this comment.
Pull request overview
Adds first-party project documentation and licensing to make the repository easier to understand, set up, and use safely—especially given the project’s live-trading capability and Python/Rust split architecture.
Changes:
- Added a comprehensive
README.mddescribing architecture, safety model, workflows, configuration, and operational guidance (demo-first, dry validation, recovery). - Added an MIT
LICENSEfile and linked it from the README.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Introduces project overview, architecture/safety guidance, setup and operational workflows, and links to internal docs. |
| LICENSE | Adds MIT license text for the project. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification
python -m pytest --ignore=tests/test_executor_integration.py(137 passed)tests/test_executor_integration.pyselection (8 passed, 2 deselected)cargo fmt --checkcargo clippy --workspace --all-targets --all-features -- -D warningscargo test --workspace --lib --bins(264 passed)git diff --checkNo source-code files are changed.