Salut à Toi's website
(c) Jérôme Poisson aka Goffi 2012
(c) Adrien Cossa aka Souliane 2015

** LICENCE **

SàT website is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SàT website is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with SàT website.  If not, see <http://www.gnu.org/licenses/>.

---

The third party projects are under compatible licences (see below)

---

The media in /static/images and /static/videos comes from Salut à Toi project and are under Creative Commons licence CC By-SA
The media in /static/css comes from Twitter Boostrap (see below) and are under Apache licence 2.0, except sat_website.css which is under AGPL v3

** ABOUT **

This is the source code of Salut à Toi's presentation website.
Salut à Toi is a communication software base on XMPP. You can have more informations on http://salut-a-toi.org (the website ran by this code).

** SETTINGS **

The following values can be set in site's settings.py:

	SAT_LINK_PATH = '/path/to/sat_link.tar.bz2' #the link should point to a SàT archive in the form sat-version.tar.bz2
	SAT_DL_PREFIX = 'ftp://ftp.goffi.org/sat' #this prefix will be joined to the filename pointed by the previous link
	SAT_DL_PATH = 'ftp://ftp.goffi.org/sat/sat.tar.bz2' #if set, this link will be used instead of the joined dl_prefix + filename

Note that the Django application "markdown_deux" ( https://github.com/trentm/django-markdown-deux ) is required.
For more information, check the local_settings.py file which is distributed in the sat_website directory.

** RUNNING THE WEBSITE LOCALLY **

This is the basic procedure to run the website on your local machine using the Django built-in web server.
Please make the difference between the project directory (e.g. ~/workspace/sat_website) and the app directory (e.g. ~/workspace/sat_website/sat_website).

First add these two lines to your shell .*rc file:

export PYTHONPATH=$PYTHONPATH:<path_to_the_app_directory>
export DJANGO_SETTINGS_MODULE=settings

Create in the app directory a file settings.py containing these lines:

try:
    from local_settings import *
except ImportError:
    pass

In the project directory, enter these commands to initialise the website:

django-admin syncdb
django-admin makemessages -a
django-admin compilemessages

All the preceding instructions had to be done just once, now you only need to type this command (again in the project directory) whenever you want to launch the web server:

django-admin runserver

** CREDIT **

The following third party project are shipped with this source code:

    - Bootstrap v3.3.1 (http://getbootstrap.com) | Copyright 2011-2014 Twitter, Inc. | MIT licence: https://github.com/twbs/bootstrap/blob/master/LICENSE
    - jQuery v1.11.1 (http://jquery.org) | Copyright 2005-2014 jQuery Foundation, Inc. | MIT licence: jquery.org/license
    - Partition (http://djangosnippets.org/snippets/401/) | Copyright 2007 Smiley Chris | Custom free (libre) licence: http://djangosnippets.org/about/tos

In addition, this project use Django to run.

Thanks to the authors/contributors of these projects

** CONTACT **

Jérôme Poisson

e-mail: goffi@goffi.org
jid: goffi@jabberfr.org