Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yagiziskirik/githubmaker

Creates Github related documents easily
https://github.com/yagiziskirik/githubmaker

git github github-generator pip python python3 readme readme-generator

Last synced: about 2 months ago
JSON representation

Creates Github related documents easily

Awesome Lists containing this project

README

        

# GithubMaker
![Version 1.1.5](https://img.shields.io/badge/version-1.1.5-blue) ![License](https://img.shields.io/badge/Licence-MIT-green) ![Maintenance](https://img.shields.io/maintenance/yes/2023) [![GithubMaker Unit Tests](https://github.com/yagiziskirik/GithubMaker/actions/workflows/python-tests.yml/badge.svg)](https://github.com/yagiziskirik/GithubMaker/actions/workflows/python-tests.yml) [![Downloads](https://static.pepy.tech/badge/githubmaker)](https://pepy.tech/project/githubmaker)

![PyPI - Downloads](https://img.shields.io/pypi/dm/GithubMaker) ![PyPI - License](https://img.shields.io/pypi/l/GithubMaker) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/GithubMaker) ![PyPI](https://img.shields.io/pypi/v/GithubMaker) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/GithubMaker) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/GithubMaker)

Creates Github related documents easily. Also, all of this repository's files has been created with this script.

## Features
* Creates Code of Conduct
* Creates Contributing Guide
* Creates License
* Creates Readme template
* Creates Security
* Creates Github template files
* Creates Gitignore file according to the OS type and programming languages that you use

## Dependencies
* Python is required for this project to work.

## Setup
```
pip install GithubMaker
```

or

```
pip3 install GithubMaker
```

## Usage
```
python -m GithubMaker.make
```

* Fill all the required fields.
* If a file is already there, it won't be overwritten.
* Program guides you which files to edit. You can follow the instructions as needed.
* Done!