Udacity's course Writing READMEs explains the importance of documenting your work. Here, you can find some supplemental resources for writing good READMEs.
- Choose A License - Helpful website for picking out a license for your project.
- Github flavored markdown reference - Github's own documentation about documentation.
- Udacity Feedback Chrome Extension - A front-end grading engine built by Cameron Pittman, a content developer at Udacity. The documentation is thorough and complete, so anybody can use it!
- factory_girl - An open source project maintained by thoughtbot. Great example of simple instructions to get you set up, which then links to external documentation.
- can.viewify - Awesome example of someone documenting her personal projects concisely.
- create-your-own-adventure - This README for Udacity's Git and Github course.
Find any typos? Have another resource you think should be included? Contributions are welcome!
First, fork this repository.
Next, clone this repository to your desktop to make changes.
$ git clone {YOUR_REPOSITORY_CLONE_URL}
$ cd ud777-writing-readmesOnce you've pushed changes to your local repository, you can issue a pull request by clicking on the green pull request icon.
Instead of cloning the repository to your desktop, you can also go to README.md in your fork on GitHub.com, hit the Edit button (the button with the pencil) to edit the file in your browser, then hit the Propose file change button, and finally make a pull request.
The contents of this repository are covered under the MIT License.