Skip to content

Instantly share code, notes, and snippets.

@heymonicakay

heymonicakay/README_HOW_TO.md

Last active January 29, 2022 01:20
Show Gist options
  • Save heymonicakay/e1ae441a3ce92f782df659402044a554 to your computer and use it in GitHub Desktop.
Save heymonicakay/e1ae441a3ce92f782df659402044a554 to your computer and use it in GitHub Desktop.
Download ZIP
Some tips on how to create a readable README to show off your project.
Raw
README_HOW_TO.md

Add a README To Your Project

You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.

What's in a README?

README files typically include information on:

  • Primary Features - What does this project do?
  • Target Audience - Who is it for?
  • Purpose - Why the project is useful/what problem does it solve?
  • Getting Started - How can someone test out the project?
  • Help - Where/How can users get help with your project?
  • Contributions - Who contributed to this project/What did they contribute?

Other things you may want to include are:

  • Images of ERD, Wirframes, etc.
  • Images of finished product
  • Animated Demos of primary features in action
  • Link to your planning documentation

Resources

How To Add Animated Demos (Gifs) To Your README.md

Loom - Screen Recording

Gifski - Turn videos into gifs

7 Ways You Can Take A Screenshot on Windows 10

How To Take A Screenshot On Your Mac

Make Your README Readable

Markdown Syntax

Markdown is a plain text formatting syntax aimed at making writing for the internet easier.

Github Documentation

Resources

Basic README Template

Make A README - Suggested Template

Example READMEs

BarkBook - Client Side Capstone by Ashton Snow

Rare: Media Publication App by Team News Hounds

Gatherings - Client Side Capstone by Emily Hartzell

Holiday Road - Itinerary App by Team Badland Bandits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment