README
1synthv1 - an old-school polyphonic synthesizer
2----------------------------------------------
3
4 an old-school 4-oscillator subtractive polyphonic synthesizer
5 with stereo fx.
6
7Features:
8
9 - pure stand-alone JACK [1] client with JACK-session, NSM [3] and both
10 JACK MIDI and ALSA MIDI [2] input support;
11
12 - LV2 [4] instrument plugin.
13 URI: http://synthv1.sourceforge.net/lv2
14
15License:
16
17 synthv1 is free, Linux Audio [5] open-source software, distributed under
18 the terms of the GNU General Public License (GPL) [6] version 2 or later.
19
20Website:
21
22 https://synthv1.sourceforge.io
23 http://synthv1.sourceforge.net
24
25Project page:
26
27 https://sourceforge.net/projects/synthv1
28
29Git repos:
30
31 https://git.code.sf.net/p/synthv1/code
32 https://github.com/rncbc/synthv1.git
33 https://gitlab.com/rncbc/synthv1.git
34 https://bitbucket.org/rncbc/synthv1.git
35
36Weblog:
37
38 https://www.rncbc.org
39
40Requirements:
41
42 mandatory,
43
44 - Qt framework [7], C++ class library and tools for
45 cross-platform application and UI development
46 https://qt.io/
47
48 optional (opted-in at build time),
49
50 - JACK [1] Audio Connection Kit
51 https://jackaudio.org/
52
53 - ALSA [2], Advanced Linux Sound Architecture
54 https://www.alsa-project.org/
55
56 - LV2 [4], Audio Plugin Standard, the extensible successor of LADSPA
57 https://lv2plug.in/
58
59 - liblo [8], Lightweight OSC implementation
60 (needed for NSM support [3])
61 http://liblo.sourceforge.net/
62
63Installation:
64
65 - unpack tarball as usual; in the extracted source directory:
66
67 cmake [-DCMAKE_INSTALL_PREFIX=/usr/local] -B build -S .
68 make -C build
69
70 - optionally, as root:
71
72 sudo make -C build install
73
74 - see also the README.cmake file in the source distribution.
75
76Acknowledgements:
77
78 synthv1 logo/icon is an original fine work of Jarle Richard Akselsen.
79
80References:
81
82 [1] JACK Audio Connection Kit
83 https://jackaudio.org/
84
85 [2] ALSA, Advanced Linux Sound Architecture
86 https://www.alsa-project.org/
87
88 [3] Non Session Management (NSM)
89 http://non.tuxfamily.org/nsm/
90
91 [4] LV2, Audio Plugin Standard, the extensible successor of LADSPA
92 http://lv2plug.in/
93
94 [5] Linux Audio consortium of libre software for audio-related work
95 https://linuxaudio.org
96
97 [6] GNU General Public License
98 https://www.gnu.org/copyleft/gpl.html
99
100 [7] Qt framework, C++ class library and tools for
101 cross-platform application and UI development
102 https://qt.io/
103
104 [8] liblo [8], Lightweight OSC implementation
105 (needed for NSM support)
106 http://liblo.sourceforge.net/
107
108
109Cheers && Enjoy.
110--
111rncbc aka. Rui Nuno Capela
112rncbc@rncbc.org
113https://www.rncbc.org
114
README.cmake
1What is CMake?
2==============
3
4CMake is a cross platform build system, that can be used to replace the old
5auto-tools, providing a nice building environment and advanced features.
6
7Some of these features are:
8* Out of sources build: CMake allows you to build your software into a directory
9 different to the source tree. You can safely delete the build directory and
10 all its contents once you are done.
11* Multiple generators: classic makefiles can be generated for Unix and MinGW,
12 but also Visual Studio, XCode and Eclipse CDT projects among other types.
13* Graphic front-ends for configuration and build options.
14
15More information and documentation is available at the CMake project site:
16 http://www.cmake.org
17
18CMake is free software. You can get the sources and pre-compiled packages for
19Linux and other systems at:
20 http://www.cmake.org/cmake/resources/software.html
21
22How to use it?
23==============
24
251. You need CMake 3.13 or newer to build synthv1
26
272. Unpack the synthv1 sources somewhere, or checkout the repository,
28 and create a build directory. For instance, using a command line shell:
29
30$ tar -xvzf Downloads/synthv1-x.y.z.tar.gz
31$ cd synthv1-x.y.z
32$ mkdir build
33
342. Execute CMake from the build directory, providing the source directory
35 location and optionally, the build options. There are several ways.
36
37* From a command line shell:
38
39$ pwd
40synthv1-x.y.z
41$ cd build
42$ cmake -DCMAKE_BUILD_TYPE=debug ..
43
443. Execute the build command. If you used the Makefiles generator (the default
45 in Linux and other Unix systems) then execute make, gmake, or mingw32-make.
46 If you generated a project file, use your IDE to build it.
47
48Compiling with make
49===================
50
51There are many targets available. To see a complete list of them, type:
52
53$ make help
54
55The build process usually hides the compiler command lines, to show them:
56
57$ make VERBOSE=1
58
59There is a "clean" target, but not a "distclean" one. You should use a build
60directory different to the source tree. In this case, the "distclean" target
61would be equivalent to simply removing the build directory.
62
63If something fails
64==================
65
66If there is an error message while executing CMake, this probably means that a
67required package is missing in your system. You should install the missing
68component and run CMake again.
69
70If there is an error executing the build process, after running a flawless CMake
71configuration process, this means that there may be an error in the source code,
72or in the build system, or something incompatible in 3rd party libraries.
73