Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Made the readme suck less (and converted it to RST).

  • Loading branch information...
commit 45390e23333c6beb105d0dfa8c862fc82404ef70 1 parent 18dd397
@ojii ojii authored
Showing with 61 additions and 79 deletions.
  1. +0 −79 README.md
  2. +61 −0 README.rst
View
79 README.md
@@ -1,79 +0,0 @@
-Django CMS 2.0
-==============
-
-A Django app for managing hierarchical pages of content in multiple languages, on different sites.
-
-Django CMS handles the navigation rendering for you in multiple languages with internationalization (i18n) slugs,
-and the navigation can be extended by your own models.
-
-Pages are rendered with a template that has placeholders which get filled via plugins.
-Plugins included at the moment include the following:
-
-* File
-* Flash
-* Google Map
-* Link
-* Picture
-* HTML Snippet
-* Teaser
-* Text
-* Video
-* Twitter
-
-
-Many more are in the works. Plugins are very easy to write and integrate with your own models.
-For a list of 3rd party plugins have a look [here](http://www.django-cms.org/en/extensions/).
-
-Tour & Screenshots
-------------------
-
-Can be found [here](http://www.django-cms.org/en/tour/).
-Some Sites done with django-cms can be found [here](http://www.django-cms.org/en/sites/)
-
-
-
-Documentation
--------------
-
-Can be found [here](http://www.django-cms.org/en/documentation/).
-
-Installation instructions can be found [here](http://www.django-cms.org/en/documentation/2.0/installation/).
-
-
-Sourcecode
-----------
-
-Can be found [here](http://github.com/divio/django-cms/) on github.
-
-Running tests
--------------
-
-`virtualenv` is highly recommended to run tests.
-
-Here's a quick drilldown on how this should work on a unix system:
-`virtualenv --no-site-packages <this directory>`
-`source bin/activate`
-`./runtests.sh --rebuild-env`
-
-The first run will bork and complain about PIL (since it's not always available as an egg, it's not in the dependencies).
-Running `easy_install pil` should take care of it on linuxes.
-
-Help
-----
-
-There is a [google group mailinglist](http://groups.google.com/group/django-cms)
-You can also visit the project website at [django-cms.org](http://www.django-cms.org/)
-or #django-cms on freenet IRC for more info.
-
-For a feature comparison of all the CMS apps available for django see
-[CMSComparison](http://code.djangoproject.com/wiki/CMSAppsComparison).
-
-Kudos
------
-
-- This is a fork of django-page-cms.
-- Some icons are from [http://www.famfamfam.com](http://www.famfamfam.com/)
-- Video plugin uses [OSFlashVideoPlayer](http://github.com/FlashJunior/OSFlashVideoPlayer)
-- Includes [Wymeditor](http://www.wymeditor.org/)
-- Tree Component from [jstree.com](http://www.jstree.com/)
-
View
61 README.rst
@@ -0,0 +1,61 @@
+##########
+django CMS
+##########
+
+A Django application for managing hierarchical pages of content, possibly in
+multiple languages and/or on multiple sites.
+
+Django CMS handles the navigation rendering for you with clean, slug based URLs,
+and this navigation can be extended by custom Django applications
+
+You can define editable areas, called placeholders, in your templates which you
+can fill with CMS plugins, by default we ship the following plugins:
+
+* File
+* Flash
+* Google Map
+* Link
+* Picture
+* HTML Snippet
+* Teaser
+* Text
+* Video
+* Twitter
+
+However this is not the end of the list, there are many
+`3rd party plugins <http://www.djangopackages.com/grids/g/django-cms/>`_
+already available for you to use. Should you be unable to find a suitable plugin
+for you needs, writing your own is very simple.
+
+More information on `our website <http://www.django-cms.org>`_.
+
+*************
+Documentation
+*************
+
+Please head over to our `documentation <http://docs.django-cms.org/>`_ for all
+the details on how to install, extend and use the django CMS.
+
+************
+Getting Help
+************
+
+Please head over to our IRC channel, #django-cms, on irc.freenode.net or write
+to our `mailing list <https://groups.google.com/forum/#!forum/django-cms>`_.
+
+*******
+Credits
+*******
+
+* This is a fork of the
+ `django-page-cms <https://github.com/batiste/django-page-cms>`_.
+* Includes icons from `FamFamFam <http://www.famfamfam.com>`_.
+* Video plugin uses the
+ `OSFlashVideoPlayer <https://github.com/FlashJunior/OSFlashVideoPlayer/>`_.
+* Includes the `Wymeditor <http://www.wymeditor.org/>`_.
+* Python tree engine powered by
+ `django-mptt <https://github.com/django-mptt/django-mptt>`_.
+* Javascript tree in admin uses `jsTree <http://www.jstree.com>`_.
+* Many thanks to the
+ `over 150 contributors <https://github.com/divio/django-cms/blob/master/AUTHORS>`_
+ to the django CMS!

0 comments on commit 45390e2

Please sign in to comment.
Something went wrong with that request. Please try again.