Skip to content

Commit 37bf46d

Browse files
committed
Cleanup readme and install file
1 parent e03c4b3 commit 37bf46d

File tree

2 files changed

+24
-70
lines changed

2 files changed

+24
-70
lines changed

INSTALL.md

Lines changed: 22 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,35 @@
1-
# --- INSTALL for Cadence ---
1+
# INSTALL instructions for Catia
22

3-
To install Cadence and its tools, simply run as usual: <br/>
4-
`$ make` <br/>
5-
`$ [sudo] make install`
3+
To install Catia, simply run as usual:
4+
```
5+
make
6+
sudo make install
7+
```
68

7-
You can run the tools without installing them, by using instead: <br/>
8-
<i>(Replace '&lt;tool&gt;' by a proper name, in lowercase. Some distros may need to use 'python' here)</i> <br/>
9-
`$ make` <br/>
10-
`$ python3 src/<tool>.py`
9+
You can run catia without installing it, by using instead: <br/>
10+
```
11+
make
12+
./src/catia.py
13+
```
1114

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

15-
<br/>
20+
## Build and Runtime Dependencies
1621

17-
===== BUILD DEPENDENCIES =====
18-
--------------------------------
19-
The required build dependencies are: <i>(devel packages of these)</i>
22+
The required build dependencies are:
2023

21-
- JACK
22-
- Qt5
2324
- PyQt5 (Py3 version)
2425

25-
On Debian and Ubuntu, use these commands to install all build dependencies: <br/>
26-
`$ sudo apt-get install libjack-jackd2-dev qtbase5-dev qtbase5-dev-tools` <br/>
27-
`$ sudo apt-get install python3-pyqt5 python3-pyqt5.qtsvg pyqt5-dev-tools`
26+
On Debian and Ubuntu, use these commands to install all build dependencies:
27+
```
28+
sudo apt-get install python3-pyqt5 python3-pyqt5.qtsvg pyqt5-dev-tools
29+
```
2830

29-
To run all the apps/tools, you'll additionally need:
31+
For additional a2jmidid integration you'll additionally need:
3032

33+
- a2jmidid
3134
- python3-dbus
3235
- python3-dbus.mainloop.qt
33-
34-
Optional but recommended:
35-
36-
- a2jmidid
37-
- jack-capture
38-
- pulseaudio[-module-jack]
39-
40-
The 'Cadence' app relies on jackdbus to work properly (either JACK2 or JACK1+DBus patch). <br/>
41-
Claudia is a LADISH frontend, so it will obviously require LADISH to run.
42-
43-
The python version used and tested is python3.2. Older versions won't work! <br/>
44-
After install, the app/tools will still work on distributions with python2 as default, without any additional work.
45-
46-
<br/>
47-
48-
===== RUNTIME DEPENDENCIES =====
49-
----------------------------------
50-
All tools require Python3 and Qt5 (PyQt5), some of them work on Windows and Mac. <br/>
51-
Here's the required run-time dependencies of each of the main tools:
52-
53-
### Cadence
54-
Requires jack <br/>
55-
Recommends a2jmidid (>= 7) and jackdbus <br/>
56-
Suggests pulseaudio[-module-jack] <br/>
57-
58-
### Cadence-JackMeter
59-
Requires jack <br/>
60-
61-
### Cadence-JackSettings
62-
Requires jackdbus <br/>
63-
64-
### Cadence-Logs
65-
No special requirements <br/>
66-
67-
### Cadence-Render
68-
Requires jack-capture <br/>
69-
70-
### Cadence-XY Controller
71-
Requires jack <br/>
72-
73-
### Catarina
74-
No special requirements <br/>
75-
76-
### Catia
77-
Requires jack <br/>
78-
Recommends a2jmidid (>= 7) and jackdbus <br/>
79-
80-
### Claudia [Linux only] <br/>
81-
Requires jackdbus and ladish <br/>
82-
Recommends a2jmidid <br/>

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Catia
1+
# ![Catia Logo](https://raw.githubusercontent.com/falkTX/Catia/master/resources/48x48/catia.png) Catia JACK Patchbay
2+
[![Build Status](https://travis-ci.org/falkTX/Catia.png)](https://travis-ci.org/falkTX/Catia)
23

34
Cadence is a simple JACK Patchbay, with some neat features like A2J bridge support and JACK Transport.
45
It was initially part of the Cadence project, but now lives on its own.

0 commit comments

Comments
 (0)