Needs python >= 2.7
[laditools.git] / INSTALL
blobe643e04ece36315f789b3eed05357abb0be7c411
1 LADI Tools - Linux Audio Desktop Integration Tools
2 --------------------------------------------------
4 LADI Tools is a set of tools aiming to achieve the goals of the LADI project
5 to improve desktop integration and user workflow of Linux audio system based
6 on JACK and LADISH. Those tools take advantage of the DBus interfaces of JACK2
7 and LADISH to ease the configuration and use of your software studio.
9 LADI Tools is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 For the complete text of the GNU General Public License version 3 see the
15 file COPYING included in this tarball.
17 How to get this software
18 ------------------------
20 Bugfix updates and new releases are made available at:
21 https://launchpad.net/laditools/+download
23 Dependencies
24 ------------
26 A version of the Python interpreter greater than or equal to 2.7 is needed
27 to build, install and run LADI Tools. Python 3 support is not yet provided.
29 Plus, the following dependencies must be satisfied:
31  - GTK+3            (>= 3.2.2,  http://www.gtk.org/)
32  - python-enum      (>= 0.4.4,  http://pypi.python.org/pypi/enum/)
33  - VTE              (>= 0.30.1, http://ftp.gnome.org/pub/GNOME/sources/vte/)
35 Here is a list of optional dependencies:
37  - libappindicator  (>= 0.4.1,  http://unity.ubuntu.com/projects/appindicators/)
39 Installation Instructions
40 -------------------------
42 Build and install laditools is a very simple task:
44     $ python setup.py install
46 To install everything relative to an alternate root directory:
48     $ python setup.py install --root=$ALTROOT
50 For more information about the available options, simply type:
52     $ python setup.py install --help install
54 For information about distutils' advanced options, type:
56     $ python setup.py --help
58 If you're a package maintainer and need help with packaging you might
59 want to ask on Freenode's channgels #jack or #LADI to either nedko or
60 or quadrispro.