https://github.com/inessadl/readme
Examples of README files and notes about how to write them.
https://github.com/inessadl/readme
documentation markdown readme readme-template
Last synced: about 1 month ago
JSON representation
Examples of README files and notes about how to write them.
- Host: GitHub
- URL: https://github.com/inessadl/readme
- Owner: inessadl
- Created: 2017-09-27T01:17:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-31T14:44:23.000Z (over 1 year ago)
- Last Synced: 2024-10-31T19:37:48.755Z (6 months ago)
- Topics: documentation, markdown, readme, readme-template
- Homepage:
- Size: 196 KB
- Stars: 46
- Watchers: 2
- Forks: 130
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- starred-awesome - readme - A few examples of README files and notes about how to write them. (Others)
README
# 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](https://github.com/dbader)
## Contributing
Please feel free to contribute by adding new templates to this project:
1. Fork it ()
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/