README

Stoq
====

Stoq's homepage is located at:

  http://www.stoq.com.br/

You can fetch the latest source code from github:

  $ git clone http://github.com/stoq/stoq.git

If you have any enhancements or bug reports, please fill them in Async's
bugzilla:

  http://bugs.async.com.br/

Please select the product name Stoq


Requirements
============

Gtk+ >= 2.20
Gudev >= 147
Kiwi >= 1.11.1
Mako >= 0.2.5
PostgresSQL >= 8.4
PyGtk >= 2.20
PySerial >= 2.1
Python >= 2.5
Python Cairo = 1.8.2
Python Dateutil >= 1.4.1
Pythin Inotify >= 0.9.2
Python Poppler 0.12.1
Python Twisted >= 10.0
Python XLWT >= 0.7.2
Python Imaging Library (PIL) >= 1.1.5
PyWebkitGtk = (1, 1, 7)
Psycopg >= 2.0.5
Reportlab >= 2.4
Stoqdrivers >= 1.3
Storm >= 0.19
Zope.interface >= 3.0
WeasyPrint >= 0.15


Running Stoq
================

The main script to run Stoq can be found in the bin directory, you can just
run it:

  $ bin/stoq

And if you're missing any dependencies it will show you so.

For complete instructions on how to install all dependencies and setting up
a database so you can test Stoq, look at the wiki:

  http://wiki.stoq.com.br/index.php/Getting_started (English)
  http://wiki.stoq.com.br/index.php/Come%C3%A7ando (Português)


New Versions
============

New versions of Stoq can be found at:

  http://www.stoq.com.br/

A list of new features in each release can be found here (portuguese only):

  http://www.stoq.com.br/novidades/

Mailing list
============

There is two mailing lists for Stoq. You can subscribe to them through the web
interface at:

http://www.async.com.br/mailman/listinfo/stoq-users
http://www.async.com.br/mailman/listinfo/stoq-devel


Copyright Information
=====================

Stoq itself is covered by the GNU General Public License
(version 2.0, or if you choose, a later version).  Basically just don't
say you wrote bits you didn't.

However, some parts of it are covered under different licesenses, see:

docs/copyright for more information