Create a gist now

Instantly share code, notes, and snippets.

Embed
What would you like to do?
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

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

@jimlyas

This comment has been minimized.

Show comment
Hide comment
@jimlyas

jimlyas Feb 9, 2018

Thanks, really helpful. . . .

jimlyas commented Feb 9, 2018

Thanks, really helpful. . . .

@keremcankabadayi

This comment has been minimized.

Show comment
Hide comment
@keremcankabadayi

keremcankabadayi commented Feb 21, 2018

great!

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