READ ME

Before I started writing the README, I did some reasearch to see what other people put in their README. At first I wanted to include information about the project like a debrief etc, but this is irrelevant to an outsider. They want to know about your project entails. In addition, it seems useful to me to know where you can find my documentation and also many contact details.

But perhaps the most important thing is to tell in your README how to install the project, what the status of your project is and how the project works.

License

Everbody on github also has a license. Public repositories on GitHub are often used to share software. To make your repo truly open source you need a license. This is so that others can freely use, modify and distribute the software. I chose the MIT Massachusetts Institute of Technology. This is because I'm okay with people sharing and improving my project they can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software.