Metadata-Version: 2.1
Name: GithubMaker
Version: 1.1.5
Summary: Creates Github related documents easily
Home-page: https://github.com/yagiziskirik/GithubMaker
Author: Yagiz Iskirik
Author-email: yagiziskirik@icloud.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md

# 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)

![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!
