Example README

Every code repository should have a README.md file in its main directory. This file is the first thing a user of the code repository will look at. In it they expect to at least find information about

• what this code is for

• who has written it

• a brief overview of how it is structured

• how to build the code

• how to run the code

Several other things can also be mentioned, e.g. information on how some result can be reproduced. But the bullet points above are the key things to include.

You can find an example README file here.

Note that this is just an example, not something you have to copy exactly.

When viewed on GitHub, the content of a README.md file (or any markdown file) is rendered nicely. If you are not familiar with using markdown syntax to write such files, take a look at the raw content of the README file, either on GitHub (click the file and then the Code button) or by opening the file in your favourite text editor.