summaryrefslogtreecommitdiff
path: root/docs/narr/myproject/README.txt
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-12-27 02:36:30 -0800
committerSteve Piercy <web@stevepiercy.com>2016-12-27 02:36:30 -0800
commite1b26edbb88ab51b1043ef82f093507d987cc2a4 (patch)
tree9cedc3b1e3d2eb33f7946273b0360a42ccfc8a23 /docs/narr/myproject/README.txt
parente2cda93d7422de50d014bcbacc2f4c31b95508bd (diff)
downloadpyramid-e1b26edbb88ab51b1043ef82f093507d987cc2a4.tar.gz
pyramid-e1b26edbb88ab51b1043ef82f093507d987cc2a4.tar.bz2
pyramid-e1b26edbb88ab51b1043ef82f093507d987cc2a4.zip
narr/project - update for cookiecutters
- update source files - update project.png - fix literalinclude reference in logging
Diffstat (limited to 'docs/narr/myproject/README.txt')
-rw-r--r--docs/narr/myproject/README.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/narr/myproject/README.txt b/docs/narr/myproject/README.txt
new file mode 100644
index 000000000..41ef0ff91
--- /dev/null
+++ b/docs/narr/myproject/README.txt
@@ -0,0 +1,29 @@
+MyProject
+===============================
+
+Getting Started
+---------------
+
+- Change directory into your newly created project.
+
+ cd MyProject
+
+- 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