Skip to content

Template for a clear GitHub README (markdown)

Notifications You must be signed in to change notification settings

chathsuom/README-cheatsheet

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

Project Name

Here goes your awesome project description!

Table of contents

General info

Add more general information about project. What the purpose of the project is? Motivation?

Screenshots

Example screenshot

Technologies

  • Tech 1 - version 1.0
  • Tech 2 - version 2.0
  • Tech 3 - version 3.0

Setup

Describe how to install / setup your local environement / add link to demo version.

Code Examples

Show examples of usage: put-your-code-here

Features

List of features ready and TODOs for future development

  • Awesome feature 1
  • Awesome feature 2
  • Awesome feature 3

To-do list:

  • Wow improvement to be done 1
  • Wow improvement to be done 2

Status

Project is: in progress, finished, no longer continue and why?

Inspiration

Add here credits. Project inspired by..., based on...

Contact

Created by @flynerdpl - feel free to contact me!

About

Template for a clear GitHub README (markdown)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published