FrancesCoronel/sampleREADME.md

Last active August 28, 2024 03:20

Star () You must be signed in to star a gist
Fork () You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/FrancesCoronel/1bfc2d4aecb01a834b46.js"></script>
Save FrancesCoronel/1bfc2d4aecb01a834b46 to your computer and use it in GitHub Desktop.

Download ZIP

A sample README for all your GitHub projects.

Raw

sampleREADME.md

Repository Title Goes Here

INSERT GRAPHIC HERE (include hyperlink in image)

Subtitle or Short Description Goes Here

ideally one sentence

include terms/tags that can be searched

Badges can go here (build status, issues (waffle.io maybe), devDependencies, npm package, coverage, slack, downloads, gitter chat, license, etc.)

For more on these wonderful ~~badgers~~ badges, refer to badgerbadgerbadger.

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.

Example

// 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/FrancesCoronel/template-repo.git

Setup

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

update and install this package first

brew update
brew install FrancesCoronel

now install npm and bower packages

npm install
bower install

For all the possible languages that support syntax highlighting on GitHub (which is basically all of them), check them out here.

Features

Insert overview of key features

Usage

Different options available

Documentation

Key things to know about

Tests

How to run tests

Contributing

To get started...

🍴 Fork this repo
🔨 View the contributing guidelines at CONTRIBUTING.md
👥 Add yourself as a contributor in this README
🔧 Open a new pull request
🎉 Get your pull request approved - success!

Or just create an issue - any little bit of help counts! 😊

Team

Or Contributors/People

FrancesCoronel	FrancesCoronel	FrancesCoronel

`github.com/FrancesCoronel`	`github.com/FrancesCoronel`	`github.com/FrancesCoronel`

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.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

More details can be found at this project's code of conduct.