.. Charmworld documentation master file, created by
   sphinx-quickstart on Fri Dec  7 09:11:04 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Charmworld's documentation!
======================================

Contents:

.. toctree::
   :maxdepth: 1

   deploy
   hacking
   api
   migrations
   todo


Important Links
================

- http://staging.jujucharms.com/~juju-jitsu/precise/charmworld
- http://staging.jujucharms.com/

Getting started
================


Initial Environment
-------------------

After you branch charmworld you can get started by running:

::

    $ make sysdeps
    $ make install


You can then run the webapp via the helper:


::

    $ make run


Note that there isn't any data out of the box.


Importing Data
---------------

Data is imported in two steps: queueing the charms, and processing the queue.
(The intent is that separate machines may queue and ingest charms.)

::

    $ bin/enqueue
    $ bin/ingest-queued

Output verbosity is controlled by the logging config in charmworld.ini


Testing
========

Testing is run via nosetests using:

::

    make test



Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`