{"id":13682762,"url":"https://github.com/udacity/ud777-writing-readmes","last_synced_at":"2025-04-30T09:34:09.676Z","repository":{"id":50413844,"uuid":"43318510","full_name":"udacity/ud777-writing-readmes","owner":"udacity","description":"Supplemental material for Udacity's \"Writing READMEs\" course","archived":false,"fork":false,"pushed_at":"2024-06-15T15:13:20.000Z","size":19,"stargazers_count":709,"open_issues_count":6,"forks_count":502,"subscribers_count":51,"default_branch":"master","last_synced_at":"2024-08-02T13:34:32.776Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/udacity.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-09-28T18:19:13.000Z","updated_at":"2024-08-01T10:41:51.000Z","dependencies_parsed_at":"2024-08-02T13:22:38.987Z","dependency_job_id":"29a391bd-5b36-4a4e-b8cc-626d2df1c7a3","html_url":"https://github.com/udacity/ud777-writing-readmes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udacity%2Fud777-writing-readmes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udacity%2Fud777-writing-readmes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udacity%2Fud777-writing-readmes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udacity%2Fud777-writing-readmes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/udacity","download_url":"https://codeload.github.com/udacity/ud777-writing-readmes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224206206,"owners_count":17273408,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T13:01:52.702Z","updated_at":"2024-11-12T02:31:44.705Z","avatar_url":"https://github.com/udacity.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# Writing READMEs README\n\nUdacity's course _Writing READMEs_ explains the importance of documenting your work. Here, you can find some supplemental resources for writing good READMEs.\n\n## Resources\n\n* [Choose A License](http://choosealicense.com/) - Helpful website for picking out a license for your project.\n* [Github flavored markdown reference](https://help.github.com/categories/writing-on-github/) - Github's own documentation about documentation.\n\n## Sample READMEs\n\n* [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!\n* [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.\n* [can.viewify](https://github.com/zkat/can.viewify) - Awesome example of someone documenting her personal projects concisely.\n* [create-your-own-adventure](https://github.com/udacity/create-your-own-adventure) - This README for Udacity's Git and Github course.\n\n## How to Contribute\n\nFind any typos? Have another resource you think should be included? Contributions are welcome!\n\nFirst, fork this repository.\n\n![Fork Icon](images/fork-icon.png)\n\nNext, clone this repository to your desktop to make changes.\n\n```sh\n$ git clone {YOUR_REPOSITORY_CLONE_URL}\n$ cd ud777-writing-readmes\n```\n\nOnce you've pushed changes to your local repository, you can issue a pull request by clicking on the green pull request icon.\n\n![Pull Request Icon](images/pull-request-icon.png)\n\nInstead 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. \n\n## License\n\nThe contents of this repository are covered under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fudacity%2Fud777-writing-readmes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fudacity%2Fud777-writing-readmes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fudacity%2Fud777-writing-readmes/lists"}