doc: initial README file

README

@@ -0,0 +1,47 @@
+Welco
+=====
+
+Welco is the central place to gather incoming requests from multiple
+channels (snail mail, email, phone, chat...) and forward them to wcs
+for them to be handled.
+
+
+Installation
+------------
+
+Dependencies can be installed with pip,
+
+ $ pip install -r requirements.txt
+
+It's then required to get the database configured (./manage.py migrate); by
+default it will create a db.sqlite3 file.
+
+You can then run the Django test server for a quick try (you should refer to
+the Django documentation for production deployments).
+
+ $ ./manage.py runserver
+
+
+Settings
+--------
+
+Default settings are loaded from settings.py, they can be overloaded by a
+local_settings.py file set in the same directory, or by a file referenced
+in the WELCO_SETTINGS_FILE environment variable.
+
+
+License
+-------
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.