Skip to content

Instantly share code, notes, and snippets.

@pedro108

pedro108/README_template.md

Last active July 11, 2022 19:51
Show Gist options
  • Save pedro108/6baebd68b017393a94caa71c323b3027 to your computer and use it in GitHub Desktop.
Save pedro108/6baebd68b017393a94caa71c323b3027 to your computer and use it in GitHub Desktop.
Download ZIP
Template for a project README
Raw
README_template.md

[[ Project Name ]]

[[ Project Short Description ]]

Table of Contents

[[ Feel free to remove any of those bullet points that do not make sense for your project ]]

About

[[ Describe more thoroughly your project here, why it exists and who are its maintainers. ]]

Development

[[ Describe here the steps that are needed to run the application in a local development environment, how to debug it and other relevant details. ]]

[[ Example linking to other file: Please follow our local development guide to setup your local environment. ]]

Testing

[[ Describe here information on how to setup and execute automated tests for your project, if there are any ]]

Unit tests

[[ This is an example of a subtopic on the table of contents. Here can be described in more detail an inner topic. ]]

Deployment

[[ Describe here information related to the deployment of your project to different run environments (dev / production). It can also detail information on Continuous Integration configuration ]]

Contribution

[[ This section is for projects that are open for external contribution. ]]

[[ Add here guides and links to communication channels to help people who want to contribute with your project. ]]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment