lakshjaisinghani / readme

Examples of README files and notes about how to write them.

readme

This repository has a few templates for README files and some notes about which type of information you could write on them.

Prepare the content

Readme files are made for developers (including you), but also could be used for the final users. So while you are writing your readme files please consider a few things:

1. What is about?
   • Describe the content of your project or repository
   • Explain things the users would have a hard time understanding right away
2. What steps need to be taken?
   • Do they need to install any software?
   • Is there any hardware requirements or dependencies?
   • After the installation, how they compile or run the code?
3. Execution examples
   • You could provide examples of execution with code and screenshots

other things you could add:

• Table of content
• Test cases
• Know bugs
• Version
• Contributors
• License
• References

Templates

• _cheatsheet.md
  • a simple markdown cheatsheet (in construction)
• assignment.md
  • an example of an university assignment
• opensource.md
  • a template for an open source project made by @dbader

Contributing

Please feel free to contribute by adding new templates to this project:

1. Fork it (https://github.com/inessadl/readme)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

References

• Choose an open source license. Github. Available at: https://choosealicense.com/
• Getting started with writing and formatting on Github. Github. Available at: https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/
• Markdown here cheatsheet. Markdown Here Wiki. Available at: https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet
• Markdown quick reference. Wordpress. Available at: https://en.support.wordpress.com/markdown-quick-reference/
• readme-template. Dan Bader. Github. Available at: https://github.com/dbader/readme-template
• Writing READMEs. Udacity. Available at: https://classroom.udacity.com/courses/ud777/