This is a short description of your Project.
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 your code is short and concise, prefer pseudo code.
This is pseudo code:
a = 42 print(a)And also this:
for i = 0 to 42 if i % 2 > 0 print(i)
This is an explanation of how and where to get the project sources or binaries.
- Version X.Y
- Version X.Z - see Installation
- Version X.X - execute
git clone https://github.com/username/sw-name.git - Other Versions
Things you need to install the software and how to install them.
# example of command to install
Things you need to do to build the software if needed.
$ example of command to build
Things you need to do to install the software if needed.
# example of command to install
This is how you can run the program and which are the options.
Usage: program [-aDde] [-f | -g] [-n number] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]
this is a note or a tip to help: try
something
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.
Describe and show how to run the tests with code examples and expected result.
$ this is a common test
This is the expected result
And this is a further test:
$ this is an unusual and huge test
This is the expected result
- see LIBRARIES files
A short snippet describing the license (MIT, Apache, etc.)