Skip to content

Instantly share code, notes, and snippets.

@don-tpanic
Forked from FrancesCoronel/sampleREADME.md
Created February 7, 2020 16:31
Show Gist options
  • Select an option

  • Save don-tpanic/885d23f4fd6f43a79028a1b064d7b50d to your computer and use it in GitHub Desktop.

Select an option

Save don-tpanic/885d23f4fd6f43a79028a1b064d7b50d to your computer and use it in GitHub Desktop.
A sample README for all your GitHub projects.

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

OR INSERT YOUR 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

Tools

QuickCast

<iframe name='quickcast' src='http://quick.as/embed/r5krugrle' scrolling='no' frameborder='0' width='100%' allowfullscreen></iframe><script src='http://quick.as/embed/script/1.60'></script>

asciinema

<script type="text/javascript" src="https://asciinema.org/a/3779.js" id="asciicast-3779" async></script>

Table of Contents (Optional)

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


Example (Optional)

// code away!

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

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...

  • Option 1

🍴 Fork this repo!

  • Option 2

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

And then follow our guidelines and make a pull request!


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!


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.

Donations (Optional)

  • You could include a Gratipay link as well. Support via Gratipay

License

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