Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scottydocs/README-template.md
A README template for anyone to copy and use.
https://github.com/scottydocs/README-template.md
Last synced: about 2 months ago
JSON representation
A README template for anyone to copy and use.
- Host: GitHub
- URL: https://github.com/scottydocs/README-template.md
- Owner: scottydocs
- Created: 2019-10-24T08:20:54.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-01T10:49:10.000Z (almost 3 years ago)
- Last Synced: 2024-06-12T16:29:35.261Z (4 months ago)
- Size: 43 KB
- Stars: 738
- Watchers: 11
- Forks: 604
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project name
![GitHub repo size](https://img.shields.io/github/repo-size/scottydocs/README-template.md)
![GitHub contributors](https://img.shields.io/github/contributors/scottydocs/README-template.md)
![GitHub stars](https://img.shields.io/github/stars/scottydocs/README-template.md?style=social)
![GitHub forks](https://img.shields.io/github/forks/scottydocs/README-template.md?style=social)
![Twitter Follow](https://img.shields.io/twitter/follow/scottydocs?style=social)Project name is a `` that allows `` to do ``.
Additional line of information text about what the project does. Your introduction should be around 2 or 3 sentences. Don't go overboard, people won't read it.
## Prerequisites
Before you begin, ensure you have met the following requirements:
* You have installed the latest version of ``
* You have a `` machine. State which OS is supported/which is not.
* You have read ``.## Installing
To install , follow these steps:
Linux and macOS:
``````
Windows:
``````
## UsingTo use , follow these steps:
```
```
Add run commands and examples you think users will find useful. Provide an options reference for bonus points!
## Contributing to
To contribute to , follow these steps:
1. Fork this repository.
2. Create a branch: `git checkout -b `.
3. Make your changes and commit them: `git commit -m ''`
4. Push to the original branch: `git push origin /`
5. Create the pull request.Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## Contributors
Thanks to the following people who have contributed to this project:
* [@scottydocs](https://github.com/scottydocs) 📖
* [@cainwatson](https://github.com/cainwatson) 🐛
* [@calchuchesta](https://github.com/calchuchesta) 🐛You might want to consider using something like the [All Contributors](https://github.com/all-contributors/all-contributors) specification and its [emoji key](https://allcontributors.org/docs/en/emoji-key).
## Contact
If you want to contact me you can reach me at .
## License
This project uses the following license: []().