Skip to content
/ Project-Template Public template

Template / Examples to use when creating new projects / repositories

Notifications You must be signed in to change notification settings

ConnerWill/Project-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project-Template

Description of {{repo_name}}

-----------------------------------------------------

ShellCheck Workflow Status License GitHub last commit GitHub issues

GitHub top language GitHub language count GitHub repo size GitLab GitHub Repo stars


➤ Table of Contents

Expand Table of Contents

-----------------------------------------------------

➤ Overview

Description

PROJECT DESCRIPTION

Demo

DESCRIPTION OF DEMO

-----------------------------------------------------

➤ Setup

SETUP INFORMATION

Installation

INSTALLATION INFORMATION

  1. Clone this repository
git clone https://github.com/ConnerWill/{{repo_name}}.git

Dependencies

DEPENDENCIES INFORMATION

: dependency-1 : dependency-1 description

: dependency-2 : *dependency-2 description

-----------------------------------------------------

➤ Usage

USAGE INFORMATION

Customization

CUSTOMIZATION INFORMATION

Hotkeys

HOTKEYS INFORMATION

Click to expand hotkeys
`↑`
`←``↓``→`

`h``j``k``l`

`TAB` `SHIFT` `ENTER`
`CTRL` `SUPER` `ALT`

`INSERT``HOME``PgUp`
`DELETE``END``PgDn`

`~` `FN` `F1`
`CAPSLOCK` `ESC`
`BACKSPACE` `DEL`

Environment Variables

ENVIRONMENT VARIABLES INFORMATION

Click to expand environment variables

ENVVAR : string : environment variable description.

ENVVAR2 : bool : environment variable description.

ENVVAR3 : string : environment variable description.

ENVVAR4 : bool : environment variable description.

𝔟𝔞𝔠𝔨 𝔱𝔬 𝔱𝔬𝔭 ⤒

Tables

Click to expand tables section

Click to expand large tables section

Large

UPPERLEFT_TITLE="TEST"
UPPERLEFT_CONTENT="test"
UPPERMIDDLE_TITLE="TEST"
UPPERMIDDLE_CONTENT="TEST"
UPPERRIGHT_TITLE="TEST"
UPPERRIGHT_CONTENT="test"
LOWERLEFT_TITLE="TEST"
LOWERLEFT_CONTENT="test"
LOWERMIDDLE_TITLE="TEST"
LOWERMIDDLE_CONTENT="test"
LOWERRIGHT_TITLE="TEST"
LOWERRIGHT_CONTENT="test"
$UPPERLEFT_TITLE$UPPERLEFT_CONTENT $UPPERMIDDLE_TITLE$UPPERMIDDLE_CONTENT $UPPERRIGHT_TITLE$UPPERRIGHT_CONTENT
$LOWERLEFT_TITLE$LOWERLEFT_CONTENT $LOWERMIDDLE_TITLE$LOWERMIDDLE_CONTENT $LOWERRIGHT_TITLE$LOWERRIGHT_CONTENT


Click to expand small tables section

Small

title status something demo
**something content demo
**something content demo
**something
**something content demo
something beta
something alpha
something alpha

𝔟𝔞𝔠𝔨 𝔱𝔬 𝔱𝔬𝔭 ⤒

-----------------------------------------------------

➤ Other

Click to expand contributing

Contributing

Any contributions you make are Greatly Appreciated

If you have a suggestion that would make this better, please fork the repo and create a pull request You can also simply open an issue

thanks ☻ 〠


  1. Fork the Project
  2. Create your Feature Branch . git checkout -b feature/AmazingFeature
  3. Commit your Changes: . . . . git commit -m 'Add some AmazingFeature'
  4. Push to the Branch . . . . . git push origin feature/AmazingFeature
  5. Then open a Pull Request

𝔟𝔞𝔠𝔨 𝔱𝔬 𝔱𝔬𝔭 ⤒


𝔟𝔞𝔠𝔨 𝔱𝔬 𝔱𝔬𝔭 ⤒

-----------------------------------------------------