https://github.com/proffapt/myreadme
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.
https://github.com/proffapt/myreadme
about-project changelog codeofconduct contributing github-about github-actions github-docs github-docs-template github-readme-example github-readme-generator github-readme-template github-release-action github-release-automation github-release-workflow github-releases license readme readme-template readymade-readme security
Last synced: 4 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/proffapt/myreadme
- Owner: proffapt
- License: agpl-3.0
- Created: 2022-03-27T18:40:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T12:26:57.000Z (over 1 year ago)
- Last Synced: 2025-04-02T08:48:18.873Z (9 months ago)
- Topics: about-project, changelog, codeofconduct, contributing, github-about, github-actions, github-docs, github-docs-template, github-readme-example, github-readme-generator, github-readme-template, github-release-action, github-release-automation, github-release-workflow, github-releases, license, readme, readme-template, readymade-readme, security
- Homepage:
- Size: 348 KB
- Stars: 10
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Table of Contents
- [About The Project](#about-the-project)
- [Supports](#supports)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contact](#contact)
- [Acknowledgements](#acknowledgments)
- [Additional documentation](#additional-documentation)
## About The Project
_Detailed explaination of the project goes here_
### Supports:
1. Shells
* `bash`
* `fish`
* `zsh`
2. OS(s)
* `MacOS`[`BSD` based]
* any `*nix`[`GNU+Linux` and `Unix`]
## 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
```sh
npm install npm@latest -g
```
### 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
```sh
git clone https://github.com/proffapt/PROJECT_NAME.git
```
2. Make the script executable
```sh
cd ./PROJECT_NAME
chmod +x ./PROJECT_NAME
```
3. Execute the script
```sh
./PROJECT_NAME
```
## 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.
## Contact
📫 Arpit Bhardwaj ( aka proffapt ) -
## Acknowledgments
* [Choose an Open Source License](https://choosealicense.com)
* [Img Shields](https://shields.io)
## Additional documentation
- [Changelogs](/.github/CHANGELOG.md)
- [License](/LICENSE)
- [Security Policy](/.github/SECURITY.md)
- [Code of Conduct](/.github/CODE_OF_CONDUCT.md)
- [Contribution Guidelines](/.github/CONTRIBUTING.md)
[contributors-shield]: https://img.shields.io/github/contributors/proffapt/PROJECT_NAME.svg?style=for-the-badge
[contributors-url]: https://github.com/proffapt/PROJECT_NAME/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/proffapt/PROJECT_NAME.svg?style=for-the-badge
[forks-url]: https://github.com/proffapt/PROJECT_NAME/network/members
[stars-shield]: https://img.shields.io/github/stars/proffapt/PROJECT_NAME.svg?style=for-the-badge
[stars-url]: https://github.com/proffapt/PROJECT_NAME/stargazers
[issues-shield]: https://img.shields.io/github/issues/proffapt/PROJECT_NAME.svg?style=for-the-badge
[issues-url]: https://github.com/proffapt/PROJECT_NAME/issues
[license-shield]: https://img.shields.io/github/license/proffapt/PROJECT_NAME.svg?style=for-the-badge
[license-url]: https://github.com/proffapt/PROJECT_NAME/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/proffapt
