Merge pull request #20 from pstch/develop

More documentation, Py3k

.travis.yml

@@ -1,6 +1,8 @@
 language: python
 python:
   - "2.7"
+  - "3.2"
+  - "3.3"
 env:
   - DJANGO=1.6
 install:

docs/gettingstarted.txt

@@ -0,0 +1,4 @@
+Getting started
+===============
+
+TODO

docs/index.txt

@@ -1,18 +1,10 @@
 django-crucrudile
 =================
 
-Contents :
-
 .. toctree::
 
-   django_crucrudile.models.mixins
-   django_crucrudile.views.mixins
-   django_crucrudile.urls
-   django_crucrudile.utils
-
-Indices and tables
-==================
+   installation
+   gettingstarted
+   reference
 
-* :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`

docs/installation.txt

@@ -0,0 +1,20 @@
+Installation
+============
+
+At this time, the only requirements to run ``django-crucrudile`` are **Python** (2.7, 3.2, 3.3), and **Django** (1.6).
+
+*Note* : support for Python 2.6 can be added pretty easily, ping me if you need it.
+
+As ``django-crucrudile`` is still in the initial development phase, I did not yet upload it to the Python package index. To install it, you can either install it as a Python egg with ``pip``, or download the source and run ``setup.py install``.
+
+To install with ``pip``::
+
+  pip install -e git+https://github.com/pstch/django-crucrudile.git#egg=django-crucrudile
+
+To install from source ::
+
+  git clone https://github.com/pstch/django-crucrudile.git
+  cd django-crucrudile
+  python setup.py install
+
+``django-crucrudile`` is a Python package, and it does **not** need to be included as an application (in ``INSTALLED_APPS``) in Django. You only need to import the needed modules in your Python files.

docs/reference.txt

@@ -0,0 +1,9 @@
+Reference
+=========
+
+.. toctree::
+
+   django_crucrudile.models.mixins
+   django_crucrudile.views.mixins
+   django_crucrudile.urls
+   django_crucrudile.utils