added contribution instruction

qaqaqaqaowh · Apr 10, 2020 · ec4f8ec · ec4f8ec
1 parent 531def9
commit ec4f8ec
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+dist
+ftg.egg-info
+build
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-A package aimed to automate creation of flask app template.
+
+A package aimed to automate creation of flask app template.
+
+Please create a new environment before executing `ftg new app_name` as it will update the requirements accordingly.
+
+---
+
+### Contribution
+
+Clone project, create branch, add code, run `python setup.py install` to test the package.
+
+After completion, psuh code, create pull request.
+
+---