INSTALL: new documentation file
[ngjackspa:ngjackspa.git] / README
1 README for ng-jackspa
2 =====================
3
4 ng-jackspa is a set of simple interfaces that host a LADSPA plugin, providing
5 JACK ports for its audio inputs and outputs, and dynamic setting of its control
6 inputs.
7
8 njackspa::
9         Visual interface for the terminal written using ncurses.
10
11 gjackspa::
12         GTK+ graphical interface for X11 written using gtkmm-2.4.
13
14 qjackspa::
15         Qt graphical interface for X11 written using Qt 4.
16
17 jackspa-cli::
18         Command-line interface for the terminal without dynamic setting of the
19         control inputs.
20
21 ng-jackspa is a fork/continuation of
22 link:http://code.google.com/p/jackspa/[jackspa].  ng-jackspa can stand either
23 for next generation jackspa or for ncurses/GTK+ jackspa.
24
25
26 Resources
27 ---------
28
29 * For a more detailed description see the manual page linkpage:ng-jackspa[1].
30
31 * The link:https://gna.org/projects/ngjackspa[official homepage] is at Gna!.
32   There you might find up-to-date information and releases.
33
34
35 Installation instructions
36 -------------------------
37 Download links, installation instructions and a list of dependencies can be
38 found in the file link:INSTALL.html['INSTALL'].
39
40
41 // Information about bugs and limitations can be found in the file 'BUGS'.
42 include::BUGS[]
43
44
45 Credits & License
46 -----------------
47 ng-jackspa has been written by G.raud Meyer (g_raud chez gna.org).  The
48 original project of which it is a forked continuation was written by Nick
49 Thomas.  The ncurses interface is based on njconnect by Pawel/Xj.
50
51 ng-jackspa is free software; you can redistribute and/or modify if under the
52 terms of the GNU General Public License version 2 as published by the Free
53 Software Foundation.  The full text of the license can be found in the root of
54 the project sources, in the file 'COPYING'.  Otherwise see
55 <http://www.gnu.org/licenses/>.