README files are text files that simply contain information about their directory. They explain why the project is useful, what kinds of files it may have, its history, or any other relevant points worth elaborating. uses Markdown extensively within its ecosystem for documentation; README files and Issues postings are written using Markdown.

Files and Directories

If a file is put in a repository’s root directory, GitHub will recognize and automatically surface your README to repository visitors - meaning it’s the first thing they’ll see, with no extra clicking.

Directory Tree
└──  assignment-01/

Don’t worry if this doesn’t quite make sense yet: we can provide an example! Go ahead, check ours out.

development directory github markdown readme