Added GitHub specifics

This commit is contained in:
Daniel Dayley 2022-05-16 13:49:45 -06:00
parent 16c6c51f4d
commit a2f7e0464f
2 changed files with 24 additions and 0 deletions

1
.github/README.md vendored Normal file
View File

@ -0,0 +1 @@
../git-readme.md

23
git-readme.md Normal file
View File

@ -0,0 +1,23 @@
# python-tool
## Description
An interactive setup script for creating new python packages.
## Usage
`./new_python_tool.sh <name_of_tool>`
## Installation
1. Download the raw setup script (`wget https://raw.githubusercontent.com/Cronocide/python-tool/master/new_python_tool.sh`)
2. Mark the script executable (`chmod +x new_python_tool.sh`)
3. Run the script to make a new package (`./new_python_tool.sh <name_of_tool>`)
## Configuration
No configuration needed.
## Justification
I frequently create new python projects and cannot remember how each kind of package is configured. This script serves as a shortcut to create new projects.