Streamline README documentation #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

mj3b wants to merge 1 commit into master from codex/update-table-of-contents-and-add-links

Owner

mj3b commented Jun 20, 2025

Summary

add a pointer to docs/ for full documentation
simplify the README table of contents
condense the phase implementation section with doc links
shorten the quick start instructions

Testing

pip install -r requirements.txt
pip install -r requirements-dev.txt
pytest -q

https://chatgpt.com/codex/tasks/task_e_6854c7e09dc08327a82f1b6b382e5d34


          docs: streamline README

4a918e4

mj3b added the codex label

— with

ChatGPT Codex Connector

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels