summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial/tutorial_approach.rst
diff options
context:
space:
mode:
authorcewing <cris@crisewing.com>2017-05-22 12:09:41 -0700
committercewing <cris@crisewing.com>2017-05-22 12:09:41 -0700
commitb033b966420b673bf0222c3576d3238773433d0f (patch)
treeba5d63e118ba5ebbad901b5c1558adff04224686 /docs/quick_tutorial/tutorial_approach.rst
parent7c680930d09d20bfa05249e01553e6488e61f1ca (diff)
parent8c4d422965b633f31967ceed1e6cc25cc616d0bf (diff)
downloadpyramid-b033b966420b673bf0222c3576d3238773433d0f.tar.gz
pyramid-b033b966420b673bf0222c3576d3238773433d0f.tar.bz2
pyramid-b033b966420b673bf0222c3576d3238773433d0f.zip
Merge branch 'master' into issue.2614
Diffstat (limited to 'docs/quick_tutorial/tutorial_approach.rst')
-rw-r--r--docs/quick_tutorial/tutorial_approach.rst35
1 files changed, 17 insertions, 18 deletions
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst
index 49a6bfd85..8da9f71b3 100644
--- a/docs/quick_tutorial/tutorial_approach.rst
+++ b/docs/quick_tutorial/tutorial_approach.rst
@@ -7,25 +7,16 @@ Details, references, and deeper discussions are mentioned in "See also" notes.
.. seealso:: This is an example "See also" note.
-This "Getting Started" tutorial is broken into independent steps, starting with
-the smallest possible "single file WSGI app" example. Each of these steps
-introduce a topic and a very small set of concepts via working code. The steps
-each correspond to a directory in this repo, where each step/topic/directory is
-a Python package.
-
-To successfully run each step:
-
-.. code-block:: bash
-
- $ cd request_response
- $ $VENV/bin/pip install -e .
-
-...and repeat for each step you would like to work on. In most cases we will
-start with the results of an earlier step.
Directory tree
==============
+This "Getting Started" tutorial is broken into independent steps, starting with
+the smallest possible "single file WSGI app" example. Each of these steps
+introduces a topic and a very small set of concepts via working code. The steps
+each correspond to a directory in our workspace, where each step's directory is
+a Python package.
+
As we develop our tutorial, our directory tree will resemble the structure
below:
@@ -41,7 +32,15 @@ below:
│── development.ini
`── setup.py
-Each of the first-level directories (e.g., ``request_response``) is a *Python
+Each of the directories in our ``quick_tutorial`` workspace (e.g., ``request_response``) is a *Python
project* (except as noted for the ``hello_world`` step). The ``tutorial``
-directory is a *Python package*. At the end of each step, we copy a previous
-directory into a new directory to use as a starting point.
+directory is a *Python package*.
+
+For most steps you will copy the previous step's directory to a new directory, and change your working directory to the new directory, then install your project:
+
+.. code-block:: bash
+
+ $ cd ..; cp -r package ini; cd ini
+ $ $VENV/bin/pip install -e .
+
+For a few steps, you won't copy the previous step's directory, but you will still need to install your project with ``$VENV/bin/pip install -e .``.