summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2008-07-25 16:38:49 +0000
committerChris McDonough <chrism@agendaless.com>2008-07-25 16:38:49 +0000
commit8f72627c090472acd0b63a2dfbf4e5dd9ed940d7 (patch)
tree886de97336fde6dc6254335315a617abe80bf8cd /docs
parent55ae8d8a831599123c4f870438332a1b21e495d5 (diff)
downloadpyramid-8f72627c090472acd0b63a2dfbf4e5dd9ed940d7.tar.gz
pyramid-8f72627c090472acd0b63a2dfbf4e5dd9ed940d7.tar.bz2
pyramid-8f72627c090472acd0b63a2dfbf4e5dd9ed940d7.zip
Tweaks.
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/project.rst40
1 files changed, 32 insertions, 8 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 1cfac5b1e..d1e703fdd 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -14,6 +14,13 @@ To start a :mod:`repoze.bfg` project, use the ``paster create``
facility::
$ paster create -t bfg
+
+``paster create`` will ask you a single question: the *name* of the
+project. You should use a string without spaces and with only letters
+in it. Here's sample output from a run of ``paster create`` for a
+project we name ``myproject``::
+
+ $ paster create -t bfg
Selected and implied templates:
repoze.bfg#bfg repoze.bfg starter project
@@ -41,13 +48,14 @@ facility::
Copying setup.py_tmpl to ./myproject/setup.py
Running /Users/chrism/projects/repoze-devel/bfg/bin/python setup.py egg_info
-The project will be created in a directory named ``myproject``. That
-directory is a :term:`setuptools` *project* directory from which a
-Python setuptools *distribution* can be created. The ``setup.py``
-file in that directory can be used to distribute your application, or
-install your application for deployment or development. A sample
-PasteDeploy ``.ini`` file named ``myproject.ini`` will also be created
-in the project directory. You can use this to run your application.
+As a result of the above, a project is created in a directory named
+``myproject``. That directory is a :term:`setuptools` *project*
+directory from which a Python setuptools *distribution* can be
+created. The ``setup.py`` file in that directory can be used to
+distribute your application, or install your application for
+deployment or development. A sample PasteDeploy ``.ini`` file named
+``myproject.ini`` will also be created in the project directory. You
+can use this to run your application.
The main ``myproject`` contains an additional subdirectory (also named
``myproject``) representing a Python pakckage which holds very simple
@@ -64,6 +72,10 @@ the following command when inside the project directory against the
generated ``setup.py``::
$ python setup.py develop
+
+Elided output from a run of this command is shown below::
+
+ $ python setup.py develop
...
Finished processing dependencies for myproject==0.1
@@ -77,6 +89,10 @@ To run unit tests for your application, you should invoke them like
so::
$ python setup.py test -q
+
+Here's sample output from a test run::
+
+ $ python setup.py test -q
running test
running egg_info
writing requirements to myproject.egg-info/requires.txt
@@ -104,10 +120,15 @@ application it represents using the ``paster serve`` command against
the generated ``myproject.ini`` configuration file::
$ paster serve myproject/myproject.ini
+
+Here's sample output from a run::
+
+ $ paster serve myproject/myproject.ini
Starting server in PID 16601.
serving on 0.0.0.0:5432 view at http://127.0.0.1:5432
-It will listen on port 5432.
+By default, generated :mod:``repoze.bfg`` applications will listen on
+port 5432.
.. note:: During development, it's often useful to run ``paster
serve`` using its ``--reload`` option. When any Python module your
@@ -122,6 +143,9 @@ Visit http://localhost:5432/ in your browser. You will see::
Welcome to myproject
+That's the page shown by default when you visit a generated
+application.
+
The Project Structure
---------------------