summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial/tutorial_approach.rst
diff options
context:
space:
mode:
authorPaul Everitt <paul@agendaless.com>2013-09-25 09:27:43 -0400
committerPaul Everitt <paul@agendaless.com>2013-09-25 09:27:43 -0400
commit187104fd81418beeb51592913041d9751bafe08d (patch)
treef87f0f64b9fdab8aacc06c96e8e6097a0e25b53e /docs/quick_tutorial/tutorial_approach.rst
parente2d5f2e4cb489a8a762e010a24fbb4d48780e7df (diff)
downloadpyramid-187104fd81418beeb51592913041d9751bafe08d.tar.gz
pyramid-187104fd81418beeb51592913041d9751bafe08d.tar.bz2
pyramid-187104fd81418beeb51592913041d9751bafe08d.zip
Quick Tutorial: Improve the setup instructions (adapted from Steve Piercy's work), particularly for Windows. Change all the steps to use $VENV/bin prefixes on commands (don't presume that they have done source env/bin/activate).
Diffstat (limited to 'docs/quick_tutorial/tutorial_approach.rst')
-rw-r--r--docs/quick_tutorial/tutorial_approach.rst40
1 files changed, 20 insertions, 20 deletions
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst
index 80af1b3d4..52d768306 100644
--- a/docs/quick_tutorial/tutorial_approach.rst
+++ b/docs/quick_tutorial/tutorial_approach.rst
@@ -2,13 +2,11 @@
Tutorial Approach
=================
-In summary:
+This tutorial uses conventions to keep the introduction focused and
+concise. Details, references, and deeper discussions are mentioned in
+"See Also" notes.
-- Tutorial broken into topics with quick working examples
-
-- Each step is a Python *package* with working code in the repo
-
-- Setup each step with ``python setup.py develop``
+.. 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.
@@ -19,7 +17,7 @@ repo, where each step/topic/directory is a Python package.
To successfully run each step::
$ cd request_response
- $ python setup.py develop
+ $ $VENV/bin/python setup.py develop
...and repeat for each step you would like to work on. In most cases we
will start with the results of an earlier step.
@@ -30,16 +28,18 @@ Directory Tree
As we develop our tutorial our directory tree will resemble the
structure below::
- request_response/
- development.ini
- setup.py
- tutorial/
- __init__.py
- home.pt
- tests.py
- views.py
-
-Each of the first-level directories are a *Python project*
-(except, as noted, the first.) The ``tutorial`` directory is a *Python
-package*. At the end of each step, we copy the old directory into a new
-directory to use as a starting point. \ No newline at end of file
+ quicktutorial/
+ request_response/
+ development.ini
+ setup.py
+ tutorial/
+ __init__.py
+ home.pt
+ tests.py
+ views.py
+
+Each of the first-level directories (e.g. ``request_response``) is a
+*Python project* (except, as noted, 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. \ No newline at end of file