{"id":13501078,"url":"https://github.com/inessadl/readme","last_synced_at":"2025-03-29T08:31:19.294Z","repository":{"id":50482170,"uuid":"104955636","full_name":"inessadl/readme","owner":"inessadl","description":"Examples of README files and notes about how to write them.","archived":false,"fork":false,"pushed_at":"2023-12-31T14:44:23.000Z","size":201,"stargazers_count":46,"open_issues_count":6,"forks_count":130,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-31T19:37:48.755Z","etag":null,"topics":["documentation","markdown","readme","readme-template"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inessadl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-27T01:17:05.000Z","updated_at":"2024-06-25T21:14:39.000Z","dependencies_parsed_at":"2024-10-31T19:32:45.345Z","dependency_job_id":"7bc46c19-9844-492e-8f7e-53858a152226","html_url":"https://github.com/inessadl/readme","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/inessadl%2Freadme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inessadl%2Freadme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inessadl%2Freadme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inessadl%2Freadme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inessadl","download_url":"https://codeload.github.com/inessadl/readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246161717,"owners_count":20733347,"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":["documentation","markdown","readme","readme-template"],"created_at":"2024-07-31T22:01:24.628Z","updated_at":"2025-03-29T08:31:19.289Z","avatar_url":"https://github.com/inessadl.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# readme\n\nThis repository has a few templates for README files and some notes about which type of information you could write on them.\n\n\n## Prepare the content\n\nReadme files are made for developers (including you), but also could be used for the final users.\nSo while you are writing your readme files please consider a few things:\n\n1. What is about?\n    - Describe the content of your project or repository\n    - Explain things the users would have a hard time understanding right away\n2. What steps need to be taken?\n    - Do they need to install any software?\n    - Is there any hardware requirements or dependencies?\n    - After the installation, how they compile or run the code?\n3. Execution examples\n    - You could provide examples of execution with code and screenshots\n\nother things you could add:\n\n- Table of content\n- Test cases\n- Know bugs\n- Version\n- Contributors\n- License\n- References\n\n## Templates\n\n- _cheatsheet.md\n    - a simple markdown cheatsheet (in construction)\n- assignment.md\n    - an example of an university assignment  \n- opensource.md\n    - a template for an open source project made by [@dbader](https://github.com/dbader)\n\n## Contributing\n\nPlease feel free to contribute by adding new templates to this project:\n\n1. Fork it (\u003chttps://github.com/inessadl/readme\u003e)\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n\n\n### References\n\n- **Choose an open source license**. Github. Available at: https://choosealicense.com/\n- **Getting started with writing and formatting on Github**. Github. Available at: https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/\n- **Markdown here cheatsheet**. Markdown Here Wiki. Available at: https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet\n- **Markdown quick reference**. Wordpress. Available at: https://en.support.wordpress.com/markdown-quick-reference/\n- **readme-template**. Dan Bader. Github. Available at: https://github.com/dbader/readme-template\n- Writing READMEs. **Udacity**. Available at: https://classroom.udacity.com/courses/ud777/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finessadl%2Freadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finessadl%2Freadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finessadl%2Freadme/lists"}