readme.markdown

# INTRO #

This project aims to create centralized forum-like discussion platform with
anonymity in mind.

Main repository: https://bitbucket.org/neko259/neboard/

Site: http://neboard.me/

# DEPENDENCIES #

## REQUIRED ##

* pillow
* django >= 1.6
* django_cleanup
* django-markupfield
* markdown
* python-markdown
* django-simple-captcha
* line-profiler

## OPTIONAL ##

* django-debug-toolbar

# INSTALLATION #

1. Install all dependencies over pip or system-wide
2. Setup a database in `neboard/settings.py`
3. Run `./manage.py syncdb` and ensure the database was created
4. Run `./manage.py migrate boards` to apply all south migrations

# RUNNING #

You can run the server using django default embedded webserver by running

    ./manage.py runserver <address>:<port>

See django-admin command help for details

Also consider using wsgi or fcgi interfaces on production servers.

# UPGRADE #

1. Backup your project data.
2. Save the settings in `neboard/settings.py` and `boards/settings.py`
3. Copy the project contents over the old project directory
4. Run migrations by `./manage.py migrate boards`

You can also just clone the mercurial project and pull it to update

# CONCLUSION #

Enjoy our software and thank you!