Chris McDonough
2010-12-19 4762ab91a3b624c877a9367d5c0141f51e7e0313
docs/index.rst
@@ -1,7 +1,7 @@
.. _index:
=================================================
The pyramid Web Application Development Framework
The Pyramid Web Application Development Framework
=================================================
:app:`Pyramid` is a small, fast, down-to-earth Python web application
@@ -38,27 +38,27 @@
   narr/firstapp
   narr/project
   narr/startup
   narr/contextfinding
   narr/traversal
   narr/resourcelocation
   narr/urldispatch
   narr/hybrid
   narr/traversal
   narr/views
   narr/handlers
   narr/hybrid
   narr/static
   narr/webob
   narr/sessions
   narr/templates
   narr/models
   narr/resources
   narr/security
   narr/i18n
   narr/vhosting
   narr/events
   narr/environment
   narr/unittesting
   narr/testing
   narr/hooks
   narr/declarative
   narr/extending
   narr/resources
   narr/assets
   narr/router
   narr/threadlocals
   narr/zca
@@ -73,14 +73,13 @@
.. toctree::
   :maxdepth: 2
   tutorials/bfg/index.rst
   tutorials/wiki/index.rst
   tutorials/wiki2/index.rst
   tutorials/bfg/index.rst
   tutorials/cmf/index.rst
   tutorials/gae/index.rst
   tutorials/modwsgi/index.rst
   tutorials/zeo/index.rst
   tutorials/zodbsessions/index.rst
   tutorials/catalog/index.rst
Reference Material
@@ -114,44 +113,53 @@
Sample Applications
===================
.. warning::
   These applications are for an older version of :app:`Pyramid`,
   which was named :mod:`repoze.bfg`.  We'll be updating them soon to
   use :app:`Pyramid`.
`repoze.cluegun <http://svn.repoze.org/repoze.cluegun/trunk/>`_ is a
simple pastebin application based on Rocky Burt's `ClueBin
`cluegun <https://github.com/Pylons/cluegun>`_ is a simple pastebin
application based on Rocky Burt's `ClueBin
<http://pypi.python.org/pypi/ClueBin/0.2.3>`_.  It demonstrates form
processing, security, and the use of :term:`ZODB` within a
:mod:`repoze.bfg` application.  It also has very simple
:term:`repoze.who` integration. Check this application out of
Subversion via::
processing, security, and the use of :term:`ZODB` within a :app:`Pyramid`
application.  Check this application out via:
  svn co http://svn.repoze.org/repoze.cluegun/trunk repoze.cluegun
.. code-block:: text
`repoze.virginia <http://svn.repoze.org/repoze.virginia/trunk/>`_ is a
very simple dynamic file rendering application.  It is willing to
render structured text documents, HTML documents, and images from a
filesystem directory.  This application runs the `repoze.org
<http://repoze.org>`_ website.  Check this application out of
Subversion via::
  git clone git://github.com/Pylons/cluegun.git
  svn co http://svn.repoze.org/repoze.virginia/trunk repoze.virginia
`virginia <https://github.com/Pylons/virginia>`_ is a very simple dynamic
file rendering application.  It is willing to render structured text
documents, HTML documents, and images from a filesystem directory.  An
earlier version of this application runs the `repoze.org
<http://repoze.org>`_ website.  Check this application out via:
`repoze.shootout <http://svn.repoze.org/repoze.shootout/trunk/>`_ is
an example "idea competition" application by Carlos de la Guardia.  It
demonstrates a hybrid of :term:`URL dispatch` and :term:`traversal`
and integration with `SQLAlchemy <http://www.sqlalchemy.org/>`_ and
:term:`repoze.who`.  Check this application out of Subversion via::
.. code-block:: text
  svn co http://svn.repoze.org/repoze.shootout/trunk repoze.shootout
  git clone git://github.com/Pylons/virginia.git
`shootout <https://github.com/Pylons/shootout>`_ is an example "idea
competition" application by Carlos de la Guardia.  It demonstrates a hybrid
of :term:`URL dispatch` and :term:`traversal` and integration with
`SQLAlchemy <http://www.sqlalchemy.org/>`_, :term:`repoze.who`, and
`Deliverance <http://www.deliveranceproject.org/>`_.  Check this application
out of version control via:
.. code-block:: text
  git clone git://github.com/Pylons/shootout.git
Older Sample Applications (repoze.bfg)
======================================
.. note::
   These applications are for an older version of :app:`Pyramid`, which was
   named :mod:`repoze.bfg`.  They won't work unmodified under Pyramid, but
   might provide useful clues.
`bfgsite <http://svn.repoze.org/bfgsite/trunk>`_ is the software which
runs the `bfg.repoze.org <http://bfg.repoze.org>`_ website.  It
demonstrates integration with Trac, and includes several
mini-applications such as a pastebin and tutorial engine.  Check a
buildout for this application out of Subversion via::
buildout for this application out of Subversion via:
.. code-block:: text
  svn co http://svn.repoze.org/buildouts/bfgsite/ bfgsite_buildout
@@ -179,7 +187,9 @@
Browse and check out tagged and trunk versions of :app:`Pyramid` via
the `Pyramid GitHub repository <http://github.com/Pylons/pyramid/>`_.
To check out the trunk via ``git``, use this command::
To check out the trunk via ``git``, use this command:
.. code-block:: text
  git clone git@github.com:Pylons/pyramid.git