Skip to content

Instantly share code, notes, and snippets.

@takakd
Forked from FrancesCoronel/sampleREADME.md
Last active August 8, 2020 14:38
Show Gist options
  • Save takakd/fe4831a92ffacd75d7a826a48c17172f to your computer and use it in GitHub Desktop.
Save takakd/fe4831a92ffacd75d7a826a48c17172f to your computer and use it in GitHub Desktop.
A sample README for all your GitHub projects.

Repository Title

Short description here.

Title Image

Badges: https://shields.io/

GitHub Actions   GitHub Actions   Badge-Rhs   Badge-Rhs   License-MIT

Table of Contents

Optional

Installation

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

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.

Example(Optional)

// code away!

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

Usage

...

Support

Reach out to me at one of the following places!

License


Features(Optional)

...

Contributing(Optional)

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(Optional)

Or Contributors/People

Example Example Example
Pict Pict Pict

FAQ(Optional)

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

Donations(Optional)

  • You could include a Gratipay link as well.

Support via Gratipay


Note

GIF Tools

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