Skip to content

Commit

Permalink
Redoing README a little bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
maraujop committed Sep 18, 2011
1 parent fd3d126 commit ee202bb
Showing 1 changed file with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,37 @@
django-uni-form
===============

Django_ forms are easily rendered as tables,
paragraphs, and unordered lists. However, elegantly rendered div based forms
is something you have to do by hand. The purpose of this application is to
provide a simple tag and/or filter that lets you quickly render forms in a div
format.
The best way to have Django_ DRY forms. Build programmatic reusable layouts out of components, having full control of the rendered HTML. All this without breaking the standard way of doing things in Django, so it plays nice with any other form application.

`Uni-form`_ has been selected as the base model for the design of the forms.
The application mainly provides:

* A filter named ``|as_uni_form`` that will render elegant div based forms. Think of it as the built-in methods: ``as_table``, ``as_ul`` and ``as_p``. You cannot tune up the output, but it is easy to start using.
* A tag named ``{% uni_form %}`` that will render a form based on your configuration and specific layout setup. This gives you amazing power without much hassle, helping you save tons of time.

By default all the templates were designed to work with `Uni-form`_, but you can create your own or use other bundles available, `see the docs`_ for more information.

.. _`see the docs`: http:https://readthedocs.org/docs/django-uni-form/en/latest/

Authors
=======

* Author: `Daniel Greenfeld`_
* Lead developer: `Miguel Araujo`_

.. _`Daniel Greenfeld`: https://github.com/pydanny
.. _`Miguel Araujo`: https://github.com/maraujop

Documentation
=============

http:https://readthedocs.org/docs/django-uni-form/en/latest/
For extensive documentation see the ``docs`` folder or `read it on readthedocs`_

.. _`read it on readthedocs`: http:https://readthedocs.org/docs/django-uni-form/en/latest/

Note
----

.. note:: django-uni-form only supports Django 1.2 or higher and Python 2.5.4, Python 2.6.x and Python 2.7.x. If you need to support earlier versions of Django or Python you will need to use django-uni-form 0.7.0.
django-uni-form only supports Django 1.2 or higher and Python 2.5.4, Python 2.6.x and Python 2.7.x. If you need to support earlier versions of Django or Python you will need to use django-uni-form 0.7.0.

.. _`Uni-form`: http:https://sprawsm.com/uni-form
.. _Django: http:https://djangoproject.com
.. _Django: http:https://djangoproject.com

0 comments on commit ee202bb

Please sign in to comment.