summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial/cookiecutters/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/quick_tutorial/cookiecutters/README.txt')
-rw-r--r--docs/quick_tutorial/cookiecutters/README.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/quick_tutorial/cookiecutters/README.txt b/docs/quick_tutorial/cookiecutters/README.txt
new file mode 100644
index 000000000..4b1f31bf3
--- /dev/null
+++ b/docs/quick_tutorial/cookiecutters/README.txt
@@ -0,0 +1,29 @@
+cc_starter
+===============================
+
+Getting Started
+---------------
+
+- Change directory into your newly created project.
+
+ cd cc_starter
+
+- Create a Python virtual environment.
+
+ python3 -m venv env
+
+- Upgrade packaging tools.
+
+ env/bin/pip install --upgrade pip setuptools
+
+- Install the project in editable mode with its testing requirements.
+
+ env/bin/pip install -e ".[testing]"
+
+- Run your project's tests.
+
+ env/bin/pytest
+
+- Run your project.
+
+ env/bin/pserve development.ini