Skip to content

Instantly share code, notes, and snippets.

@indidatajones

indidatajones/checklist-readme.md

Last active May 9, 2019 12:57
Show Gist options
  • Save indidatajones/630ae490a1a0bf886ecb2ed5465a7870 to your computer and use it in GitHub Desktop.
Save indidatajones/630ae490a1a0bf886ecb2ed5465a7870 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
checklist-readme.md

The README Checklist

A helpful checklist to gauge how your README is coming along:

  • One-liner explaining the purpose of the module
  • Necessary background context & links
  • Potentially unfamiliar terms link to informative sources
  • Clear, runnable example of usage
  • Installation instructions
  • Extensive API documentation
  • Performs cognitive funneling
  • Caveats and limitations mentioned up-front
  • Doesn't rely on images to relay critical information
  • License
Raw
sample-readme.md

FVCproductions

INSERT GRAPHIC HERE (include hyperlink in image)

Repository Title Goes Here

Subtitle or Short Description Goes Here

ideally one sentence

include terms/tags that can be searched

Badges will go here

  • build status
  • issues (waffle.io maybe)
  • devDependencies
  • npm package
  • coverage
  • slack
  • downloads
  • gitter chat
  • license
  • etc.

Build Status Dependency Status Coverage Status Code Climate Github Issues Pending Pull-Requests Gem Version License Badges

INSERT ANOTHER GRAPHIC HERE

INSERT YOUR GRAPHIC HERE

  • Most people will glance at your README, maybe star it, and leave
  • Ergo, people should understand instantly what your project is about based on your repo

Tips

  • HAVE WHITE SPACE
  • MAKE IT PRETTY
  • GIFS ARE REALLY COOL

GIF Tools

  • Use Recordit to create quicks screencasts of your desktop and export them as GIFs.
  • For terminal sessions, there's ttystudio which also supports exporting GIFs.

Recordit

Recordit GIF

ttystudio

ttystudio GIF

Table of Contents (Optional)

If you're README has a lot of info, section headers might be nice.

Example (Optional)

// code away!

let generateProject = project => {
  let code = [];
  for (let js = 0; js < project.length; js++) {
    code.push(js);
  }
};

Installation

  • All the code required to get started
  • Images of what it should look like

Clone

  • Clone this repo to your local machine using https://github.com/fvcproductions/SOMEREPO

Setup

  • If you want more syntax highlighting, format your code like this:

update and install this package first

$ brew update
$ brew install fvcproductions

now install npm and bower packages

$ npm install
$ bower install
  • For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

Features

Usage (Optional)

Documentation (Optional)

Tests (Optional)

  • Going into more detail on code and technologies used
  • I utilized this nifty Markdown Cheatsheet for this sample README.

Contributing

To get started...

Step 1

  • Option 1

    • 🍴 Fork this repo!

  • Option 2

    • 👯 Clone this repo to your local machine using https://github.com/joanaz/HireDot2.git

Step 2

  • HACK AWAY! 🔨🔨🔨

Step 3

Team

Or Contributors/People

FVCproductions FVCproductions FVCproductions
FVCproductions FVCproductions FVCproductions
github.com/fvcproductions github.com/fvcproductions github.com/fvcproductions
  • You can just grab their GitHub profile image URL
  • You should probably resize their picture using ?s=200 at the end of the image URL.

FAQ

  • How do I do specifically so and so?
    • No problem! Just do this.

Support

Reach out to me at one of the following places!

Donations (Optional)

  • You could include a Gratipay link as well.

Support via Gratipay

License

License

Raw
standard-readme.md

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment