diff --git a/INSTALL.md b/INSTALL.md index 1a57216..d35e5db 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,82 +1,35 @@ -# --- INSTALL for Cadence --- +# INSTALL instructions for Catia -To install Cadence and its tools, simply run as usual:
-`$ make`
-`$ [sudo] make install` +To install Catia, simply run as usual: +``` +make +sudo make install +``` -You can run the tools without installing them, by using instead:
-(Replace '<tool>' by a proper name, in lowercase. Some distros may need to use 'python' here)
-`$ make`
-`$ python3 src/.py` +You can run catia without installing it, by using instead:
+``` +make +./src/catia.py +``` Packagers can make use of the 'PREFIX' and 'DESTDIR' variable during install, like this:
-`$ make install PREFIX=/usr DESTDIR=./test-dir` +``` +make install PREFIX=/usr DESTDIR=/path/to/pkg/dir +``` -
+## Build and Runtime Dependencies -===== BUILD DEPENDENCIES ===== --------------------------------- -The required build dependencies are: (devel packages of these) +The required build dependencies are: - - JACK - - Qt5 - PyQt5 (Py3 version) -On Debian and Ubuntu, use these commands to install all build dependencies:
-`$ sudo apt-get install libjack-jackd2-dev qtbase5-dev qtbase5-dev-tools`
-`$ sudo apt-get install python3-pyqt5 python3-pyqt5.qtsvg pyqt5-dev-tools` +On Debian and Ubuntu, use these commands to install all build dependencies: +``` +sudo apt-get install python3-pyqt5 python3-pyqt5.qtsvg pyqt5-dev-tools +``` -To run all the apps/tools, you'll additionally need: +For additional a2jmidid integration you'll additionally need: + - a2jmidid - python3-dbus - python3-dbus.mainloop.qt - -Optional but recommended: - - - a2jmidid - - jack-capture - - pulseaudio[-module-jack] - -The 'Cadence' app relies on jackdbus to work properly (either JACK2 or JACK1+DBus patch).
-Claudia is a LADISH frontend, so it will obviously require LADISH to run. - -The python version used and tested is python3.2. Older versions won't work!
-After install, the app/tools will still work on distributions with python2 as default, without any additional work. - -
- -===== RUNTIME DEPENDENCIES ===== ----------------------------------- -All tools require Python3 and Qt5 (PyQt5), some of them work on Windows and Mac.
-Here's the required run-time dependencies of each of the main tools: - -### Cadence -Requires jack
-Recommends a2jmidid (>= 7) and jackdbus
-Suggests pulseaudio[-module-jack]
- -### Cadence-JackMeter -Requires jack
- -### Cadence-JackSettings -Requires jackdbus
- -### Cadence-Logs -No special requirements
- -### Cadence-Render -Requires jack-capture
- -### Cadence-XY Controller -Requires jack
- -### Catarina -No special requirements
- -### Catia -Requires jack
-Recommends a2jmidid (>= 7) and jackdbus
- -### Claudia [Linux only]
-Requires jackdbus and ladish
-Recommends a2jmidid
diff --git a/README.md b/README.md index e044bf4..8b71959 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# Catia +# ![Catia Logo](https://raw.githubusercontent.com/falkTX/Catia/master/resources/48x48/catia.png) Catia JACK Patchbay +[![Build Status](https://travis-ci.org/falkTX/Catia.png)](https://travis-ci.org/falkTX/Catia) Cadence is a simple JACK Patchbay, with some neat features like A2J bridge support and JACK Transport. It was initially part of the Cadence project, but now lives on its own.