A template for useful READMEs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
LICENSE
README-template.md
README.md

README.md

README Template

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.

Features

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

Getting Started

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

Getting Help

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.

Contributing Guidelines

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.

Code of Conduct

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.

Credits

Several projects and articles aided in inspiring this project. Notably they are:

License

This project is licensed under The Unlicense and released to the Public Domain. For more information see our LICENSE file.