Re-write README.md #9
Description
The first thing visitors to this repository will see on GitHub is going to be the README.md file. This is paramount to explaining the project, it's goals and basic use instructions.
As we continue to develop, I feel we may be losing some initial interest from visitors by keeping up the original bare-bones README.md. The current version was never intended to be used long term and it's time we prioritize re-writing to reflect the current state of PyMaengDa.
Items to be included may include, but are not limited to:
- General overview (PR Continue work on README.md update #16)
- Current development status (PR Continue work on README.md update #16)
- Development goals/roadmap
- Requirements (PR Feature/update readme #11)
- Basic installation instructions (venv, pip install, run-in-place, etc) (PR Feature/update readme #11, Fix in PR Continue work on README.md update #16)
- Basic use instructions with reference to main documentation when available (PR Continue work on README.md update #16)
- Contributing basics with link to
CONTRIBUTING.md