pythonindia
[Suggestion] on the Readme Structure
I suggest we keep installation instruction separate from Readme, to maintain consistency in the instructions until we have a solid documentation structure. I am sharing a skeleton for the README, I feel we can use with the relevant images and gifs to welcome new users.
#589 #545
Junction | <status buttons>
Latest Version: xx.xx
Overview with the project demo gif, image so that new users can see how the project looks themselves, or hosting a demo version.
Features
- Overview about features
Getting Started/Quick-Start
With brief and links about following sections on readthedocs.
- Installation / Setup Guidelines
- How to use the project with hyperlink to tutorial section on readthedocs.
Contribute?
Adding a brief and links to the relevant page on readthedocs:
- on contribution guideline
- Prerequisites, such as knowledge of Git/Python/Django etc.
Community
How to contact the contributors section with details of zulip chat room or IRC channel details.
License
Brief on the license the project is using.
If we agree on the structure, I can create a pull request with the updated README with all the relevant details from our current Readme which we can update over time.