Permalink
Browse files

Cleaned up README and docs.

  • Loading branch information...
1 parent a00e13d commit 63e7f070b589c545eaccb8beb36463c4e48aadca @melinath melinath committed Mar 8, 2013
Showing with 78 additions and 50 deletions.
  1. +1 −1 MANIFEST.in
  2. +0 −47 README.md
  3. +67 −0 README.rst
  4. +1 −1 docs/guides/installation-and-setup.rst
  5. +8 −0 docs/index.rst
  6. +1 −1 setup.py
View
@@ -1,4 +1,4 @@
-include README.md
+include README.rst
include AUTHORS
include MANIFEST.in
recursive-include daguerre/static *
View
@@ -1,47 +0,0 @@
-Django Daguerre
-===============
-
-**Django Daguerre** makes it easy to adjust images on-the-fly without
-slowing down your templates and without needing to generate everything
-ahead of time with a cron job. You don't need to make any changes to
-your models; it **Just Works**.
-
-Requirements
-------------
-
-* Python 2.5+
-* PIL 1.1.7 (Or [Pillow](http://pypi.python.org/pypi/Pillow))
-
-Installation
-------------
-
-You can install the latest version of Daguerre using `pip`:
-
- pip install django-daguerre
-
-Setup
------
-
-Ensure that `'daguerre'` is in your project's `INSTALLED_APPS`:
-
- INSTALLED_APPS = (
- 'daguerre',
- ...
- )
-
-Add the following or similar anywhere in your URLconf:
-
- urlpatterns = patterns('',
- url(r'^daguerre/', include('daguerre.urls')),
- ...
- )
-
-Usage
------
-
-The easiest way to use Daguerre is through the `{% adjust %}` template tag:
-
- {% load daguerre %}
- <img src="{% adjust my_model.image.name width=128 height=256 %}" />
-
-For more on using Daguerre, [read the documentation](http://django-daguerre.readthedocs.org/).
View
@@ -0,0 +1,67 @@
+README
+======
+
+**Django Daguerre** makes it easy to adjust images on-the-fly without
+slowing down your templates and without needing to generate everything
+ahead of time with a cron job. You don't need to make any changes to
+your models; it **Just Works**.
+
+.. code-block:: html+django
+
+ {% load daguerre %}
+ <img src="{% adjust my_model.image width=200 height=400 %}" />
+
+ {% adjust_bulk my_queryset "image" width=200 height=400 as adjusted_dict %}
+ {% for my_model, image in adjusted_dict.iteritems %}
+ <img src="{{ image }}" />
+ {% endfor %}
+
+
+:code: http://github.com/oberlin/django-daguerre
+:docs: http://readthedocs.org/docs/django-daguerre/
+:build status: |build-image|
+
+.. |build-image| image:: https://secure.travis-ci.org/oberlin/django-daguerre.png?branch=master
+ :target: http://travis-ci.org/oberlin/django-daguerre/branches
+
+Requirements
+------------
+
+* Python 2.6+
+* PIL 1.1.7 (Or `Pillow <http://pypi.python.org/pypi/Pillow>`_)
+
+Installation
+------------
+
+You can install the latest version of Daguerre using ``pip``::
+
+ pip install django-daguerre
+
+You can clone the repository yourself at https://github.com/oberlin/django-daguerre.
+
+.. highlight:: python
+
+Setup
+-----
+
+Ensure that ``'daguerre'`` is in your project's ``INSTALLED_APPS``::
+
+ INSTALLED_APPS = (
+ 'daguerre',
+ ...
+ )
+
+Add the following or similar anywhere in your URLconf::
+
+ urlpatterns = patterns('',
+ url(r'^daguerre/', include('daguerre.urls')),
+ ...
+ )
+
+Testing
+-------
+
+We recommend running `tox`_ from the repository's root directory,
+but you can also run ``test_project/manage.py test daguerre``.
+
+.. _tox: http://tox.readthedocs.org/en/latest/
@@ -4,7 +4,7 @@ Installation and Setup
Requirements
------------
-* Python 2.5+
+* Python 2.6+
* PIL 1.1.7 (Or `Pillow <http://pypi.python.org/pypi/Pillow>`_)
Installation
View
@@ -24,6 +24,14 @@ your models; it **Just Works**.
<img src="{{ image }}" />
{% endfor %}
+
+:Code: http://github.com/oberlin/django-daguerre
+:Docs: http://readthedocs.org/docs/django-daguerre/
+:Build status: |build-image|
+
+.. |build-image| image:: https://secure.travis-ci.org/oberlin/django-daguerre.png?branch=master
+ :target: http://travis-ci.org/oberlin/django-daguerre/branches
+
Contents
--------
View
@@ -10,7 +10,7 @@
version='.'.join([str(v) for v in version]),
url="http://django-daguerre.readthedocs.org/",
description='Image management and processing for Django.',
- long_description=open(os.path.join(os.path.dirname(__file__), 'README.md')).read(),
+ long_description=open(os.path.join(os.path.dirname(__file__), 'README.rst')).read(),
license='BSD',
packages=find_packages(),
include_package_data=True,

0 comments on commit 63e7f07

Please sign in to comment.