Permalink
Browse files

Improve README even further, including CSS form layout tips

  • Loading branch information...
1 parent f96eabf commit a3a036d7120ef79027981e1e95d8b09d9ae1f8ad @vdboor vdboor committed Jul 18, 2012
Showing with 50 additions and 9 deletions.
  1. +50 −9 README.rst
View
@@ -27,14 +27,6 @@ To use comments, the following settings are required::
'django.contrib.comments',
)
-Optionally, `django-threadedcomments`_ can be included::
-
- INSTALLED_APPS += (
- 'threadedcomments',
- )
-
- COMMENTS_APP = 'threadedcomments'
-
Add the following in ``urls.py``::
urlpatterns += patterns('',
@@ -54,6 +46,55 @@ The database can be created afterwards::
./manage.py runserver
+CSS form layout
+---------------
+
+A form layout is something that is very different across web sites.
+However, this module uses django-crispy-forms_ for the form HTML layout, to make it easy to
+have a consistent layout across all your Django forms (in fact, we would encourage to adopt django-crispy-forms_ for all your form layouts).
+
+Currently this module gives you 2 options for the layout:
+
+* `Bootstrap`_ The default template pack. The popular simple and flexible HTML, CSS, and Javascript for user interfaces from Twitter.
+* `Uni-form`_ Nice looking, well structured, highly customizable, accessible and usable forms.
+
+The ``CRISPY_TEMPLATE_PACK`` setting allows you to choose which layout you like to use.
+For more information, see the django-crispy-forms_ documentation..
+
+If your form CSS framework is not supported, you can create a template pack
+for it and submit a pull request to the django-crispy-forms_ authors for inclusion.
+
+
+Treaded comments
+----------------
+
+There is rudimentary support for `django-threadedcomments`_ in this module,
+which can be enabled with the following settings::
+
+ INSTALLED_APPS += (
+ 'threadedcomments',
+ )
+
+ COMMENTS_APP = 'threadedcomments'
+
+Note however, that some improvements to django-treadedcomments_ are still open
+(see `pull request #39 <https://github.com/HonzaKral/django-threadedcomments/pull/39>`_)
+and until that moment it is not possible to take full advantage of the treaded display.
+
+
+Contributing
+------------
+
+This module is designed to be generic, and easy to plug into your site.
+In case there is anything you didn't like about it, or think it's not
+flexible enough, please let us know. We'd love to improve it!
+
+If you have any other valuable contribution, suggestion or idea,
+please let us know as well because we will look into it.
+Pull requests are welcome too. :-)
+
+
.. _django-threadedcomments: https://github.com/HonzaKral/django-threadedcomments.git
.. _django-crispy-forms: http://django-crispy-forms.readthedocs.org/
-
+.. _`Uni-form`: http://sprawsm.com/uni-form
+.. _`Bootstrap`: http://twitter.github.com/bootstrap/index.html

0 comments on commit a3a036d

Please sign in to comment.