summaryrefslogtreecommitdiff
path: root/docs/quick_tour/package/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/quick_tour/package/README.txt')
-rw-r--r--docs/quick_tour/package/README.txt27
1 files changed, 26 insertions, 1 deletions
diff --git a/docs/quick_tour/package/README.txt b/docs/quick_tour/package/README.txt
index 63aaf6fbd..fb7bde0a7 100644
--- a/docs/quick_tour/package/README.txt
+++ b/docs/quick_tour/package/README.txt
@@ -1,4 +1,29 @@
-hello_world README
+hello_world
+===============================
+Getting Started
+---------------
+- Change directory into your newly created project.
+ cd hello_world
+
+- 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