Skip to content
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.

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

[Suggestion] on the Readme Structure #696

Open
miphilomath opened this issue Jun 13, 2020 · 1 comment
Open

[Suggestion] on the Readme Structure #696

miphilomath opened this issue Jun 13, 2020 · 1 comment
Labels

Comments

@miphilomath
Copy link

miphilomath commented Jun 13, 2020

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.

@miphilomath
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants