Added README
authorEriol
Tue, 16 Nov 2010 15:01:44 +0100
changeset 43d92a88f7c022
parent 42 1d5e014e932a
child 44 1e83f485ab79
Added README
MANIFEST.in
README
     1.1 --- a/MANIFEST.in	Tue Nov 16 12:46:48 2010 +0100
     1.2 +++ b/MANIFEST.in	Tue Nov 16 15:01:44 2010 +0100
     1.3 @@ -1,6 +1,7 @@
     1.4  include AUTHORS
     1.5  include LICENSE
     1.6  include MANIFEST.in
     1.7 +include README
     1.8  recursive-include microcms/locale *
     1.9  recursive-include microcms/templates *
    1.10  
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/README	Tue Nov 16 15:01:44 2010 +0100
     2.3 @@ -0,0 +1,42 @@
     2.4 +========
     2.5 +microcms
     2.6 +========
     2.7 +
     2.8 +``microcms`` is a minimalistic enhancement of Django flatpages app. It provides
     2.9 +few additional fields and integrates CKeditor.
    2.10 +
    2.11 +Installation
    2.12 +============
    2.13 +
    2.14 +Assuming that you want to install ``microcms`` version 0.1:
    2.15 +
    2.16 +    $ pip install http://hg.mornie.org/django/microcms/@v0.1#egg=microcms
    2.17 +
    2.18 +Or download a packaged version and and use Python's ``distutils`` to install.
    2.19 +
    2.20 +Getting started
    2.21 +===============
    2.22 +
    2.23 +Previously you must have correctly set up Django ``flatpages``.
    2.24 +
    2.25 +Simply add ``"microcms"`` to your ``INSTALLED_APPS`` after ``"flatpages"``.
    2.26 +
    2.27 +CKeditor integration
    2.28 +====================
    2.29 +
    2.30 +Default settings assumes that CKeditor is available at
    2.31 +``MEDIA_URL/ckeditor/ckeditor.js``. You can change it using CKEDITOR_URL in
    2.32 +your settings.py:
    2.33 +
    2.34 +    CKEDITOR_URL = "path/to/ckeditor.js"
    2.35 +
    2.36 +CKEDITOR_URL will be prepended with MEDIA_URL so you can use a relative path.
    2.37 +
    2.38 +You can need to add some custom css to fix displaying issues or to customize the
    2.39 +admin page. CKeditor kama theme, for example, doesn't look good without a fix.
    2.40 +Just use MICROCMS_CUSTOM_CSS in your settings.py:
    2.41 +
    2.42 +    MICROCMS_CUSTOM_CSS = ('kama-fix.css',)
    2.43 +
    2.44 +Don't forget to use a tuple: this is done to give greater flexibility. Again
    2.45 +values inside MICROCMS_CUSTOM_CSS will be prepended with MEDIA_URL.