This repo provides a adaptable template for your project's README. For many, your README will their introduction to your project. This README template aims to provide guidelines on writing a REAMDE that is both useful and inviting.
This template aims to include guidance on:
- Writing an understandable getting started guide for your project
- Providing support information to users
- Writing welcoming and effective contribution guidelines
- Providing information on your project's code of conduct
- Providing license information for your software
To use the template copy the contents of README-template.md, save it as README.md in the root of your project, and use your text editor to edit the document as necessary.
You can also easily copy the file from your terminal using curl. From the root of your project directory, run the following command:
curl https://raw.githubusercontent.com/ascott1/readme-template/master/README-template.md > README.md
If you have questions or need further guidance on using this template, please file an issue. I will do my best to respond to all issues in a timely manner.
All contributions and suggestions are welcome!
For suggested improvements, please file an issue.
For direct contributions, please fork the repository and file a pull request. If you never created a pull request before, welcome 🎉 😄 Here is a great tutorial on how to send one.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
This project pledges to follow the Contributor's Covenant.
Several projects and articles aided in inspiring this project. Notably they are:
- CFPB's Open Source Project Template
- Jesse Luoto's README Best Practices
- Write the Doc's Beginner’s Guide
- Hoodie's Contributing Guidelines
- 18F's Open Source Maintainer Guidelines
This project is licensed under The Unlicense and released to the Public Domain. For more information see our LICENSE file.