Skip to content

docs: add project README and MIT license - #2

Merged
AaronL725 merged 2 commits into
mainfrom
codex/readme
Jul 16, 2026
Merged

docs: add project README and MIT license#2
AaronL725 merged 2 commits into
mainfrom
codex/readme

Conversation

@AaronL725

@AaronL725 AaronL725 commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Summary

  • document Prodigy's Python research and Rust execution architecture
  • add risk, safety, configuration, Demo, live dry-validation, Telegram, and recovery guidance
  • provide verified setup, research, testing, and smoke-run commands
  • license the project under MIT and link the license from the README
  • state current experimental boundaries without overstating maturity

Verification

  • python -m pytest --ignore=tests/test_executor_integration.py (137 passed)
  • safety-only tests/test_executor_integration.py selection (8 passed, 2 deselected)
  • cargo fmt --check
  • cargo clippy --workspace --all-targets --all-features -- -D warnings
  • cargo test --workspace --lib --bins (264 passed)
  • git diff --check
  • GitHub GFM render and local-link validation
  • GitHub license API identifies the added text as MIT

No source-code files are changed.

@AaronL725 AaronL725 changed the title docs: add project README docs: add project README and MIT license Jul 16, 2026
@AaronL725
AaronL725 marked this pull request as ready for review July 16, 2026 18:39
Copilot AI review requested due to automatic review settings July 16, 2026 18:39
@AaronL725
AaronL725 merged commit ea1c111 into main Jul 16, 2026
1 check passed
@AaronL725
AaronL725 deleted the codex/readme branch July 16, 2026 18:40

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md describing architecture, safety model, workflows, configuration, and operational guidance (demo-first, dry validation, recovery).
  • Added an MIT LICENSE file 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.

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.

2 participants