Skip to content

Instantly share code, notes, and snippets.

@ohidurbappy
Forked from FrancesCoronel/sampleREADME.md
Created July 15, 2022 00:03
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ohidurbappy/c63480d67f299530edde899fd8f96316 to your computer and use it in GitHub Desktop.
Save ohidurbappy/c63480d67f299530edde899fd8f96316 to your computer and use it in GitHub Desktop.
A sample README for all your GitHub projects.

Repository Title Goes Here

Frances Coronel

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

Build Status Coverage Status Gem Version License Badges Financial Contributors on Open Collective GitHub Issues GitHub Pull Requests MIT License Donate via PayPal Netlify Status

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.

Recordit GIF

For terminal sessions, there's ttystudio which also supports exporting GIFs.

ttystudio GIF

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/SOMEREPO

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), refer 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...

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

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

Team

Or Contributors/People

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

License

License

Copyright 2022 © Frances Coronel

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