Git Product home page Git Product logo

proffapt / myreadme Goto Github PK

View Code? Open in Web Editor NEW
10.0 1.0 4.0 356 KB

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: GNU Affero General Public License v3.0

changelog codeofconduct contributing license readme github-about github-docs readme-template about-project github-docs-template

myreadme's Introduction

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)

myreadme's People

Contributors

harshkhandeparkar avatar proffapt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.