Files

Pages Images Audio and Video Scripts Text Documents TODO

Directories

Web Directories (“Folders”) Directory Structure Best Naming Practices TODO

Documentation

Plain Text Files Markdown Files README Files TODO

Developing with GitHub.com

Git Version Control Create a New Repository Edit a File Create a New File Upload a File TODO

README Files

README files are text files that 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.

GitHub.com uses Markdown extensively within its ecosystem for documentation; README files and Issues postings are written using Markdown.

Files and Directories

Placing the README.md file the repository’s root directory, results in GitHub recognizing and automatically displaying the README to repository visitors - meaning it’s the first thing they’ll see, with no extra clicking.

Directory Tree

.
└──  assignment-02/
    └──  README.md

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