aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf12615
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+CookieMan
+=========
+
+### How to use?
+
+This project is a template for kickstarting my projects. It uses cookiecutter
+which is a python module you can install with pip:
+
+```
+$ pip install cookiecutter
+```
+
+Then to start a new project simply call cookiecutter and supply the address of
+this repo:
+
+```
+$ cookiecutter https://github.com/thornycrackers/cookiecutter_docker.git
+```
+
+You will be prompted answer a couple questions about your project and then after
+that you will be ready to rock and roll.