From 8864e39e694580e2747b3691dd7acd0337b24eec Mon Sep 17 00:00:00 2001 From: Serghei Mihai Date: Tue, 12 Jul 2016 11:12:42 +0200 Subject: [PATCH] initial README --- README | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..8c7dd06 --- /dev/null +++ b/README @@ -0,0 +1,41 @@ +Corbo +===== + +Corbo is a announce management system allowing users to subscribe via email, +sms and RSS stream. + + +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 + + +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 . + + +