Skip to content

Instantly share code, notes, and snippets.

@NeoTeo

NeoTeo/README.md

Last active April 12, 2017 11:33
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save NeoTeo/d5b0449b413c24975b8c3965bf68f316 to your computer and use it in GitHub Desktop.
Save NeoTeo/d5b0449b413c24975b8c3965bf68f316 to your computer and use it in GitHub Desktop.
Download ZIP
README.md template for modules
Raw
README.md

PROJECT NAME

A one-line project description.

A longer description of the project.

Install

Installation/build instructions.

Usage

How to use/include the module in your project

Examples

Example usage of the module in a project.

let example_code = true

Requirements

Language requirements

Todo

  • things that are planned
  • With strikethrough you can show recently completed todos.✅

Notes

Misc. that doesn't fit elsewhere.

License

MIT

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