README

What is a README.txt?

It’s pretty much a file that will replace your design folders, as seen in the MYP.  Many programs have README’s which explain the functionality and installation process.

How do I create a txt file?

You can do this directly from Android Studio with File->New File->Other->Empty File and name it README.txt

Can I make it README.md?

Yes, you can. txt is the OG way, md has fancy new formatting options.

What should I Include?

• Your name.
• The project name.
• Class and date.
• A brief one or two sentence description of what the program is supposed to do.
• A link to your design document.

Do you have any examples?

Yeah.

Example 1

Why do we need to do this?

Documentation is very important in programming. Write it as a love letter to your future self. You might want to come back to these projects and it’ll be easier to know what’s going on if your documentation is well done. You also might want to share them or add on to them in the future.

If you’re working on a team, the README can act as an organizational space for your team.

If you look at just about any Github Project you will find a README. It is a common practice that should always be prioritized.