Skip to content

Instantly share code, notes, and snippets.

@indexzero

indexzero/readme-outline.md

Created November 14, 2011 08:26
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save indexzero/1363524 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save indexzero/1363524 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. indexzero revised this gist Nov 14, 2011. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion readme-outline.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    # README.md Outline
    ## README.md Outline

    * Header and a Brief description (should match package.json)
    * Example (if applicable)
  2. indexzero revised this gist Nov 14, 2011. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions readme-outline.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,3 +1,5 @@
    # README.md Outline

    * Header and a Brief description (should match package.json)
    * Example (if applicable)
    * Motivation (if applicable)
  3. indexzero created this gist Nov 14, 2011.
    14 changes: 14 additions & 0 deletions readme-outline.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,14 @@
    * Header and a Brief description (should match package.json)
    * Example (if applicable)
    * Motivation (if applicable)
    * API Documentation: _This will likely vary considerably from library to library._
    * Installation
    * Tests
    * Contributors
    * License

    **Bonus Points**

    1. The file is named exactly `README.md` (not `ReadMe.md`, or `README`)
    2. The license file is named exactly `LICENSE` (not `MIT-LICENSE`, or `license`)
    3. The entire license is not included in `README.md`, just a snippet saying it is MIT or Apache or whatever