Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathijs de Bruin committed Sep 25, 2010
1 parent dcf0059 commit 1b1e8b4
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.rst
Expand Up @@ -22,11 +22,15 @@ Installation
#) Install the package using ``pip install -e git://github.com/dokterbob/django-newsletter.git#egg=django_newsletter``
#) ``ln -s <my_project>/<media_dir> <newsletter_install_dir>/media``
#) Add ``newsletter`` to ``INSTALLED_APPS`` in ``settings.py``
#) Make sure dependency ``tinymce`` is in ``INSTALLED_APPS`` and configure
``TINYMCE_JS_URL`` to point to wherever ``tiny_mce.js`` is located.
(Typically ``/media/tinymce/tiny_mce/tiny_mce.js``)
#) Run unit tests just to be sure it is working: ``./manage.py test newsletter``.
#) If it is not, let me know. Create an issue on GitHub or send me a message.

Usage
-----
#) Load up default newsletter template fixtures: ``./manage.py loaddata default_templates``
#) Start the development server: ``./manage.py runserver``
#) Navigate to ``/admin/`` and: behold!
#) Put a submission in the queue.
Expand All @@ -49,6 +53,7 @@ TODO
* Finish front end for article ordering from admin.
* Write tests for: template syntax checking, ordering of articles in a
message.
* Extend subscription models to allow for mail deliverability feedback.

License
-------
Expand Down

0 comments on commit 1b1e8b4

Please sign in to comment.