Skip to content

Commit

Permalink
Stop quoting bullet points in README
Browse files Browse the repository at this point in the history
  • Loading branch information
codeinthehole authored and Sebastian Vetter committed Aug 21, 2013
1 parent a31682c commit 990af15
Showing 1 changed file with 36 additions and 37 deletions.
73 changes: 36 additions & 37 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Fancy CMS-style page editing for Django
.. image:: https://coveralls.io/repos/tangentlabs/django-fancypages/badge.png?branch=master
:target: https://coveralls.io/r/tangentlabs/django-fancypages?branch=master


.. note: This is a work in progress and part of this project will likely change
and could potentially break things. Be careful with using it.
Expand All @@ -31,51 +30,54 @@ Installation

To use ``django-fancypages`` in your own project follow these steps:

1. install via pip into you virtualenv (for now you have to install from
the github repo because we haven't released it to PyPI yet)::
1. Install via pip into you virtualenv (for now you have to install from
the github repo because we haven't released it to PyPI yet)::

$ pip install git+https://github.com/tangentlabs/django-fancypages.git

$ pip install git+https://github.com/tangentlabs/django-fancypages.git
2. Add the required apps to your ``INSTALLED_APPS`` by simply using the
convenience function ``get_apps`` in the ``fancypages`` module::

2. add the required apps to your ``INSTALLED_APPS`` by simply using the
convenience function ``get_apps`` in the ``fancypages`` module::
from fancyages import get_required_apps, get_fancypages_apps

from fancyages import get_required_apps, get_fancypages_apps
YOUR_OTHER_APPS = (
...
)
INSTALLED_APPS = YOUR_OTHER_APPS + get_required_apps() + get_fancypages_apps()

YOUR_OTHER_APPS = (
...
)
INSTALLED_APPS = YOUR_OTHER_APPS + get_required_apps() + get_fancypages_apps()
3. Add the editor middleware that provides the editing panel to every
fancypage or page that contains an FP container::

3. Add the editor middleware that provides the editing panel to every
fancypage or page that contains an FP container::
MIDDLEWARE_CLASSES = (
...
'fancypages.middleware.EditorMiddleware',
)

MIDDLEWARE_CLASSES = (
...
'fancypages.middleware.EditorMiddleware',
)
4. Add the urls for ``django-fancypages`` to your project's main
``urls.py``. Make sure that it is at the end of you definitions
otherwise the it will prevent your other URLs from working because it
defines a rather generic URL pattern for its pages::

4. Add the urls for ``django-fancypages`` to your project's main
``urls.py``. Make sure that it is at the end of you definitions
otherwise the it will prevent your other URLs from working because it
defines a rather generic URL pattern for its pages::
urlpatterns = patterns('',
...
url(r'^', include(fancypages.urls)),
)

urlpatterns = patterns('',
...
url(r'^', include(fancypages.urls)),
)
5. Fancypages requires several default settings to be added. To make sure
that you have all the default settings in your settings, you can use
the defaults provided by fancypages itself. Add the following in your
settings file **before** you overwrite specific settings::

5. Fancypages requires several default settings to be added. To make sure
that you have all the default settings in your settings, you can use
the defaults provided by fancypages itself. Add the following in your
settings file **before** you overwrite specific settings::
...

...
from fancypages.defaults import *

from fancypages.defaults import *
...

...
CSS
~~~

**Compiling CSS:** the CSS used by fancypages is generated by less using
The CSS used by fancypages is generated by less using
``django-compressor``. This means you have to have ``lessc`` installed on your
system or in your virtualenv. You can either take care of that yourself or
use the ``requirements_less.txt`` file with ``pip`` to install both into your
Expand All @@ -86,10 +88,7 @@ virtualenv::
That's been a bit of work, hasn't it? Well done! Your should now be able to
access the fancypages dashboard after staring the Django server by running
``./manage.py runserver`` or whatever else you do for that. A very basic
dashboard should now be available at:

http://localhost:8000/dashboard/fancypages

dashboard should now be available at: http://localhost:8000/dashboard/fancypages

Projects Using Fancypages
-------------------------
Expand Down

0 comments on commit 990af15

Please sign in to comment.