docs: restructure README with usage and roadmap #2

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

Draft

AMarinhoSN wants to merge 1 commit into develop from codex/revise-and-enhance-readme.md-sections

Collaborator

AMarinhoSN commented Aug 26, 2025

Summary

Rewrite README introduction with project summary and bullet-point features
Add sections for prerequisites, installation, basic usage, and paper reproduction workflow
Append roadmap, citation, contributing, and license sections with consistent code blocks

Testing

python --version
PYTHONPATH=. python scripts/ssaxgeo -h (fails: ModuleNotFoundError: No module named 'pandas')
pytest

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


          docs: restructure README with usage and roadmap

d27a37c

AMarinhoSN 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