From a2f7e0464f92543a055925fe15e4c672a3b3d201 Mon Sep 17 00:00:00 2001
From: Daniel Dayley <ddayley@qualtrics.com>
Date: Mon, 16 May 2022 13:49:45 -0600
Subject: [PATCH] Added GitHub specifics

---
 .github/README.md |  1 +
 git-readme.md     | 23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+)
 create mode 100644 .github/README.md
 create mode 100644 git-readme.md

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 <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.