You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Task]: Update the README, package metadata, and repository presentation #70
The README and public repository page are out of date. They do not describe the current just-based workflow, Docker/CI setup, or the direction MiniMap is taking. pyproject.toml still uses a placeholder description. The project needs an accurate public identity before it is used in a demo or portfolio.
Proposed change
Rewrite the README to describe MiniMap's actual purpose, graph-based indoor navigation for university buildings, along with its current capabilities and limitations. Document just install, just run, just check, just docker, data validation, project structure, architecture, and CONTRIBUTING.md. Give pyproject.toml a meaningful description and an intentional package/distribution name, while keeping 0.1.0 unless the release plan changes. Configure the GitHub repository display name/capitalization, a concise description, and relevant topics. Set a homepage only after the deployment is verified.
Affected modules or data
README.md
pyproject.toml
GitHub repository description, display metadata, topics, and eventually homepage
No application behavior or release/tag creation
Acceptance criteria
README uses the final MiniMap name consistently and removes obsolete clone/setup material.
Setup, verification, Docker, and map-data commands reflect the current just workflow.
The documented architecture, capabilities, and limitations are honest and match current code.
pyproject.toml has a meaningful description and intentional project name.
The repository page has a non-empty description and confirmed display name/topics.
Commands and links work from a clean clone.
Testing requirements
Run the documented commands from a clean clone or equivalent clean environment. Verify rendered README links on GitHub and read back repository metadata after changing it.
Dependencies and risks
This depends on the contribution workflow in #67. Do not create v0.1.0, change dependencies, claim unsupported functionality, or set a deployment homepage before the deployment issue is complete.
changed the title [-][Task]: Refresh README, package metadata, and repository presentation[/-][+][Task]: Update the README, package metadata, and repository presentation[/+]on Sep 8, 2026
Activity
[-][Task]: Refresh README, package metadata, and repository presentation[/-][+][Task]: Update the README, package metadata, and repository presentation[/+]