diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..49e03f7 --- /dev/null +++ b/.github/README.md @@ -0,0 +1 @@ +../git-readme.md diff --git a/git-readme.md b/git-readme.md new file mode 100644 index 0000000..5761f69 --- /dev/null +++ b/git-readme.md @@ -0,0 +1,23 @@ +# python-tool + +## Description + +An interactive setup script for creating new python packages. + +## Usage + +`./new_python_tool.sh ` + +## 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 `) + +## 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.