readme.txt

Here is a skeleton for a README.md

Synopsis
CodeExample
Motivation
Installation
API Reference
Tests
Contributors
License
Synopsis


Readme
A short introduction and/ or overview explaining the project. This description matches descriptions added for package managers (Gemspec, package.json, etc.)

Example
Make the API obvious. Short, concise demonstration that enables any developer to use your code as a tool for problem solving.

Motive/Influences
Why are we creating this and how long will it last? Will there be any maintenance?  Where did our ideas come from? Where did we lift code?

Installation
Simple How-to

API Reference
Reference documentation stored as a library, glossary, index or link to these.

Test
Describe and show how to run the tests with code examples.  What testing software?

Contributors
Who's on it?  What issue tickets initiated the project?  Current?

License
Describe the license (MIT, Apache, etc.) in a word or two.