An Accessible and Usable GitHub Repository

After adding a few repositories to GitHub, I realized I neglected to discuss README.md. This is a place where you can put notes about your project which will appear on the repository page. For example, here’s the README.md from my newest repository, promises-browser.

See [this article](https://ramonaridgewell.wordpress.com/2017/04/24/my-js-journey-a-promise-in-a-browser/) for a description of how to set up this project.

It shows up at the bottom of the GitHub page, after the list of files. It’s also a good practice to add a description, a link to a webpage, and topics (up near the top).

Screen Shot 2017-04-24 at 12.06.05

I’ve been linking to the articles in my blog for setup instructions, but you could include pertinent notes in the README.md, and they will show up there.

Copyright ©2014-17 Ramona Ridgewell. All rights reserved.

Advertisements
This entry was posted in #Education, AmWriting, Coding, Education, GitHub, JavaScript, Science, Women, Writing and tagged , , , , , , , , , . Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s