Skip to content

Commit

Permalink
Document the need to install the generated package.
Browse files Browse the repository at this point in the history
Fixes issue #1.
  • Loading branch information
tseaver committed Nov 6, 2011
1 parent 00955a9 commit 153a6d0
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/index.rst
Expand Up @@ -22,7 +22,7 @@ a virtualenv) to install the software:
.. code-block:: text .. code-block:: text
$ cd pyramid_jqm $ cd pyramid_jqm
$ python setup.py develop $ /path/to/python setup.py develop
Generating a Sample Application Generating a Sample Application
------------------------------- -------------------------------
Expand All @@ -34,12 +34,18 @@ application:


.. code-block:: text .. code-block:: text
$ paster create -t pyramid_jqm_starter MyApp $ /path/to/paster create -t pyramid_jqm_starter MyApp
This will create a ``MyApp`` :term:`distribution`, in which will live a This will create a ``MyApp`` :term:`distribution`, in which will live a
``myapp`` Python :term:`package`. The distribution represents a ``myapp`` Python :term:`package`. The distribution represents a
redistributable Pyramid application. The code which drives the application redistributable Pyramid application. The code which drives the application
lives within the package. lives within the package. You need to install that package as well:

.. code-block:: text
$ cd myapp
$ /path/to/python setup.py develop

This comment has been minimized.

Copy link
@natea

natea Nov 7, 2011

Note that if you create a virtualenv and activate it, then you don't need to put the full path to Python. Also, another way to install everything would be to make a requirements.txt with pyramid and the current directory. Then rather than running python setup.py develop twice, you could just run pip install -r requirements.txt once.

The Generated Application The Generated Application
------------------------- -------------------------
Expand Down

0 comments on commit 153a6d0

Please sign in to comment.