Skip to content
/ myREADME Public template

Contains my templates for README.md, LICENSE.txt CONTRIBUTING.md COC.md, issues & pull_request. With a workflow to generate/update CHANGELOG.md and draft release on tag push.

License

Notifications You must be signed in to change notification settings

proffapt/myREADME

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 

Contributors Forks Stargazers Issues MIT License LinkedIn


image

PROJECT_NAME

Project one liner slogan goes here
Request Feature | Report Bug

Table of Contents

About The Project

Detailed explaination of the project goes here

(back to top)

Supports:

  1. Shells
    • bash
    • fish
    • zsh
  2. OS(s)
    • MacOS[BSD based]
    • any *nix[GNU+Linux and Unix]

(back to top)

Getting Started

To set up a local instance of the application, follow the steps below.

Prerequisites

The following dependencies are required to be installed for the project to function properly:

  • npm
    npm install npm@latest -g

(back to top)

Installation

Now that the environment has been set up and configured to properly compile and run the project, the next step is to install and configure the project locally on your system.

  1. Clone the repository
    git clone https://github.com/proffapt/PROJECT_NAME.git
  2. Make the script executable
    cd ./PROJECT_NAME
    chmod +x ./PROJECT_NAME
  3. Execute the script
    ./PROJECT_NAME

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space.

(back to top)

Contact

📫 Arpit Bhardwaj ( aka proffapt ) - proffapt's Twitter proffapt's Telegram proffapt's LinkedIn proffapt's mail proffapt's forum for cybernity

(back to top)

Acknowledgments

(back to top)

Additional documentation

(back to top)