Skip to content

Instantly share code, notes, and snippets.

@robbiethegeek
Forked from jxson/README.md
Last active August 29, 2015 14:26
Show Gist options
  • Save robbiethegeek/f59499b1ef2a86285da0 to your computer and use it in GitHub Desktop.
Save robbiethegeek/f59499b1ef2a86285da0 to your computer and use it in GitHub Desktop.
README.md template

Synopsis

At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Motivation

A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.

Installation

Provide code examples and explanations of how to get the project.

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Tests

Describe and show how to run the tests with code examples.

Contributors

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.

License

MIT

                    MM                  
          =MN       MMM                 
           MMMMD     MMM    ?M=         
             7MMMM~   MMN   MM=         
                NMMMM: MMM  MM=         
   MMMMMMMMMMMMMMMMMMMMMDM$ MM=         
    MMMMMMMMMMNOMMMMMMMMMMMNMM=   ?=    
            ?MMMMN      $MMMIM= IMM8    
          MMMMMM          NMMM= MM7     
       NMMM?MMD            ?MM=MMM      
    DMMMM? MMM              MM7MD       
 =MMMMI   MMMM              MMMM        
MMMN     MM=MM              MMM,MMMM$   
        MMM MM             MMMMMMM      
       NMM  MM            MMMMM:        
      MMM   MM        =NMMMM:           
     $MM    MM     MMMMMMMMMMMMM$       
    NMM=    MM                          
   =MM,     MM                          
   :=       MM                          
            MM                          
            MM                          
            MM                          
            MM
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment