src/README.md

   1      #    Software as a service (SaaS), which allows anyone to manage their money,
   2      #    in the virtual world, transparently, without intermediaries.
   3      #
   4      #    Copyright (C) 2013 Diego Pardilla Mata
   5      #
   6      #    This file is part of Shoali.
   7      #
   8      #    Shoali is free software: you can redistribute it and/or modify
   9      #    it under the terms of the GNU Affero General Public License as published by
  10      #    the Free Software Foundation, either version 3 of the License, or
  11      #    (at your option) any later version.
  12      #
  13      #    This program is distributed in the hope that it will be useful,
  14      #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15      #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16      #    GNU Affero General Public License for more details.
  17      #
  18      #    You should have received a copy of the GNU Affero General Public License
  19      #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22 Shoali is a software as a service (SaaS) do it with Django framework, which
  23 allows anyone to manage their money, in the virtual world, transparently,
  24 without intermediaries.
  25
  26 It has (among others) the following major features
  27
  28  * Lend money to anyone you want and how you want, without intermediaries.
  29  * Borrow money to anyone you want and how you want, without intermediaries.
  30  * Allows you to manage, in the virtual world, your money transparently.
  31
  32 #Installation:
  33
  34  See [INSTALL](INSTALL.md) file for information on how to install shoali
  35
  36 #Starting shoali:
  37
  38  XXXXXXXXXXXXXXXXXXXXXXXXXXX (TODO)
  39
  40 #More information:
  41
  42  * <http://www.shoali.org> (web & homepage TODO)
  43  * <http://notebook.papersize.org> (blog, it's possible that in the future
  44  change to the domain shoali.org, with the URL: blog.shoali.org)
  45  * <https://gitorious.org/shoali/pages/Home> (now), <http://wiki.shoali.org> (wiki TODO)
  46
  47 #Written by:
  48
  49  see [AUTHORS](AUTHORS.md) for more information
  50
  51 #Reporting Bugs:
  52
  53  Please report bugs to our mailing list or our bugtracker:
  54
  55  * <dev@shoali.org> (Developers mailing list)
  56  * <http://bug.shoali.org> (Bugtracker)
  57
  58 #Development:
  59
  60  If you just want to develop code, you can clone Shoali of Gitorious
  61  repository, as follows:
  62
  63     user@machine:~>git clone git://gitorious.org/shoali/shoali.git shoali
  64
  65  For more information:
  66
  67  * <https://gitorious.org/shoali> (Git Repository)
  68  * <dev@shoali.org> (Developers mailing list)
  69  * <admin@shoali.org> (Administrator)
  70
  71 #Contacting us:
  72
  73  * <users@shoali.org> (Users mailing list)
  74  * <munikes@shoali.org> (mUniKeS)
  75  * <munikes@members.fsf.org> (mUniKeS)
  76  * <pardilla@members.fsf.org> (Diego Pardilla Mata)