Why should I create a README?
READMEs are fun to create and are an important part of your personal profile and your organization's profile. Writing an excellent README file for your open-source project's repository is equally important. The README file is the first impression of your project that potential contributors and new users get. While your Contributing .md allows contributors to make and merge pull requests in your repository,Users can find instructions on how to use your project in your README file.
What should I write in my README?
- - Start by adding the title for your project
- - Make sure there is a banner image or logo included
- - Be brief and to the point when describing your project
- - Prerequisites should be listed
- - Specify the installation commands
- - Provide as many examples as possible.
A README is very important, but can be intimidating to a beginner. Using a README generator can make creating a README for a project easy.
- Readme.so
- Github profile readme generator
- https://www.makeareadme.com/
My Top pick would be: Readme.so
Top comments (1)
Thanks for this. I didn't know this existed.