Skip to content

Instantly share code, notes, and snippets.

@lilgallon
Last active May 28, 2019 11:01
Show Gist options
  • Save lilgallon/c1e3554d7f178bce71103b845054ab58 to your computer and use it in GitHub Desktop.
Save lilgallon/c1e3554d7f178bce71103b845054ab58 to your computer and use it in GitHub Desktop.
Readme template for my projects

CTRL+R:

  • -> repository name
  • N3RO -> github name
  • -> short description
  • -> name of the course
  • -> name of the university
  • -> grade of the project
  • CONTRIBUTING.md -> url to CONTRIBUTING.md
  • CHANGELOG.md -> url to CHANGELOG.md
  • -> license name
  • LICENSE.md -> url to LICENSE
  • <title> -\> project title
  • .github/screenshot.png -> url to preview image

Utility:

<title>

Latest release opissues clissues

. Made for the course at the (grade: ).

preview

1. Getting started

1.1 Prerequisites

1.2 How to use it

1.3 Setting up your dev environment

1.4 Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

2. Miscellaneous

2.1 Changelog

The changelog is available here.

2.2 Authors

2.3 License

This project is licensed under the license - see the LICENSE file for details

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