https://github.com/udacity/ud777-writing-readmes

Supplemental material for Udacity's "Writing READMEs" course
https://github.com/udacity/ud777-writing-readmes

Last synced: 3 days ago
JSON representation

Supplemental material for Udacity's "Writing READMEs" course

• Host: GitHub
• URL: https://github.com/udacity/ud777-writing-readmes
• Owner: udacity
• License: mit
• Created: 2015-09-28T18:19:13.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-06-15T15:13:20.000Z (5 months ago)
• Last Synced: 2024-08-02T13:34:32.776Z (3 months ago)
• Homepage:
• Size: 18.6 KB
• Stars: 709
• Watchers: 51
• Forks: 502
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Writing READMEs README

Udacity's course _Writing READMEs_ explains the importance of documenting your work. Here, you can find some supplemental resources for writing good READMEs.

## Resources

* [Choose A License](http://choosealicense.com/) - Helpful website for picking out a license for your project.

* [Github flavored markdown reference](https://help.github.com/categories/writing-on-github/) - Github's own documentation about documentation.

## Sample READMEs

* [Udacity Feedback Chrome Extension](https://github.com/udacity/frontend-grading-engine) - 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_bot](https://github.com/thoughtbot/factory_bot) - 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](https://github.com/zkat/can.viewify) - Awesome example of someone documenting her personal projects concisely.

* [create-your-own-adventure](https://github.com/udacity/create-your-own-adventure) - This README for Udacity's Git and Github course.

## How to Contribute

Find any typos? Have another resource you think should be included? Contributions are welcome!

First, fork this repository.

![Fork Icon](images/fork-icon.png)

Next, clone this repository to your desktop to make changes.

```sh

$ git clone {YOUR_REPOSITORY_CLONE_URL}

$ cd ud777-writing-readmes

```

Once you've pushed changes to your local repository, you can issue a pull request by clicking on the green pull request icon.

![Pull Request Icon](images/pull-request-icon.png)

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. 

## License

The contents of this repository are covered under the [MIT License](LICENSE).