Skip to content

Commit

Permalink
Cleanup readme and install file
Browse files Browse the repository at this point in the history
  • Loading branch information
falkTX committed Aug 4, 2020
1 parent e03c4b3 commit 37bf46d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 70 deletions.
91 changes: 22 additions & 69 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,35 @@
# --- INSTALL for Cadence ---
# INSTALL instructions for Catia

To install Cadence and its tools, simply run as usual: <br/>
`$ make` <br/>
`$ [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: <br/>
<i>(Replace '&lt;tool&gt;' by a proper name, in lowercase. Some distros may need to use 'python' here)</i> <br/>
`$ make` <br/>
`$ python3 src/<tool>.py`
You can run catia without installing it, by using instead: <br/>
```
make
./src/catia.py
```

Packagers can make use of the 'PREFIX' and 'DESTDIR' variable during install, like this: <br/>
`$ make install PREFIX=/usr DESTDIR=./test-dir`
```
make install PREFIX=/usr DESTDIR=/path/to/pkg/dir
```

<br/>
## Build and Runtime Dependencies

===== BUILD DEPENDENCIES =====
--------------------------------
The required build dependencies are: <i>(devel packages of these)</i>
The required build dependencies are:

- JACK
- Qt5
- PyQt5 (Py3 version)

On Debian and Ubuntu, use these commands to install all build dependencies: <br/>
`$ sudo apt-get install libjack-jackd2-dev qtbase5-dev qtbase5-dev-tools` <br/>
`$ 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). <br/>
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! <br/>
After install, the app/tools will still work on distributions with python2 as default, without any additional work.

<br/>

===== RUNTIME DEPENDENCIES =====
----------------------------------
All tools require Python3 and Qt5 (PyQt5), some of them work on Windows and Mac. <br/>
Here's the required run-time dependencies of each of the main tools:

### Cadence
Requires jack <br/>
Recommends a2jmidid (>= 7) and jackdbus <br/>
Suggests pulseaudio[-module-jack] <br/>

### Cadence-JackMeter
Requires jack <br/>

### Cadence-JackSettings
Requires jackdbus <br/>

### Cadence-Logs
No special requirements <br/>

### Cadence-Render
Requires jack-capture <br/>

### Cadence-XY Controller
Requires jack <br/>

### Catarina
No special requirements <br/>

### Catia
Requires jack <br/>
Recommends a2jmidid (>= 7) and jackdbus <br/>

### Claudia [Linux only] <br/>
Requires jackdbus and ladish <br/>
Recommends a2jmidid <br/>
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 37bf46d

Please sign in to comment.