docs/index.rst

   1 .. _index:
   2
   3 ==============================
   4 vudo
   5 ==============================
   6
   7 The vudo project aims to extend :mod:`repoze.bfg`, a `Python
   8 <http://www.python.org>`_ web framework, with functionality tailored
   9 for content-driven applications. See the `framework documentation
  10 <http://static.repoze.org/bfgdocs/>`_ to learn more about the
  11 platform.
  12
  13 The software is developed and released under a `BSD-like license
  14 <http://www.zope.org/Resources/ZPL>`_.
  15
  16 We share Python's philosophy of having one obvious way to do things
  17 which also helps limiting the scope of the project as a whole: a
  18 framework can only take you so far.
  19
  20
  21 Getting started
  22 ===============
  23
  24 The best way to get acquainted with the software is to check out and
  25 install the demo application. The following steps shows you how to do
  26 this using the ``buildout`` build system.
  27
  28 Start by cloning the project repository::
  29
  30   ~ $ git clone http://repo.or.cz/r/voodoo.git vudo
  31
  32 This will pull down the most recent revision of the repository. Now we
  33 can build out the demo application::
  34
  35   ~ $ cd vudo/demo/weblog
  36   weblog $ python2.5 bootstrap.py
  37   weblog $ bin/buildout
  38
  39 To run the demo application, you need to start the application using
  40 :mod:`Paste`::
  41
  42   weblog $ bin/paster serve debug.ini
  43
  44 Packages
  45 ========
  46
  47 The library packages are the main focus of the project; when possible,
  48 packages are self-contained and provide immediate functionality for
  49 the developer.
  50
  51 :mod:`vudo.cmf`
  52    Provides a minimal content management framework that other packages can extend with specific functionality. Most applications will use this package.
  53
  54
  55 Index
  56 =====
  57
  58 .. toctree::
  59    :maxdepth: 2
  60
  61    api/vudo
  62
  63 Support and Development
  64 =======================
  65
  66 Bugs should be reported to the `mailinglist
  67 <http://groups.google.com/group/vudo>`_.
  68
  69 You can browse the `repository <http://repo.or.cz/w/voodoo.git>`_ or
  70 check out a development copy using Git::
  71
  72   git clone git+ssh://<username>@repo.or.cz/srv/git/voodoo.git
  73
  74 Note that in order to check out the repository you must create a
  75 (free) account at `repo.or.cz <http://repo.or.cz>`_.
  76
  77 Indices and tables
  78 ==================
  79
  80 * :ref:`genindex`
  81 * :ref:`modindex`
  82 * :ref:`search`
  83