Skip to content

Instantly share code, notes, and snippets.

@uchidaknet
Created October 18, 2013 04:24
Show Gist options
  • Save uchidaknet/7036478 to your computer and use it in GitHub Desktop.
Save uchidaknet/7036478 to your computer and use it in GitHub Desktop.
This is a template of Readme for open source modules.

Readme Template for OSS(){

Website | Facebook | Twitter

This is a template of Readme for open source modules.

screenshot

  1. Introduction
  2. Features
  3. Requirements
  4. Installtion
  5. Usage
  6. License

foo bar foo bar

[⬆]

foo bar foo bar

[⬆]

  • XXXXXX SDK 1.0 or later
  • XXXXXX 5.0 or later

[⬆]

Install this module

var install = "foo"

[⬆]

Create foo

var foo = "bar"

Create bar

var bar = "foo"

[⬆]

  • [Ver.X.X.X]Released on Oct 18, 2013
  • [Ver.X.X.X]Released on Oct 19, 2013
  • [Ver.X.X.X]Released on Oct 20, 2013
  • [Ver.X.X.X]Released on Oct 21, 2013

[⬆]

Readme Template for OSS
License here.

[⬆]

};

© year your name All rights reserved.

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