README What is a readme? It's basically a simple user manual so that others who are attempting to use your software know how to build it and run it.