1 ----------------------------------------------------------------------------
2| |
3| This is "Kwave", a sound editor built on KDE Frameworks 5 |
4| |
5 ----------------------------------------------------------------------------
6
7 ----------------------------------------------------------------------------
8| It is hosted on KDE and on SourceForge, so you are welcome to visit |
9| the Kwave homepage at: "http://kwave.sourceforge.net" for details. |
10 ----------------------------------------------------------------------------
11
12If you are interested what has been done and what has to be done, then
13look at the files "CHANGES" and "TODO" included in this package.
14
15The project is developed and published under the GNU GENERAL PUBLIC LICENSE
16(Version 2, from June 1991), take a look at the file "GNU-LICENSE" included
17in the source package.
18
190. PREFACE:
20==========
21
22Please note that required packages for compiling Kwave vary between
23different distributions and versions. It is practically impossible
24to give a complete list of packages and versions, so if you can't
25get along, please feel free to ask on the Kwave mailing list!
26
271. COMPILING MANUALLY:
28=====================
29
30>>> NOTE: You don't have to do this on an rpm based system, you can
31 easily build a rpm package of Kwave. Please skip this and
32 advance to section 2.
33
34It's quite simple. First get the source archive, unpack it in a driectory
35of your choice and then generate it in a separate build directory.
36For example:
37
38cd ${HOME}/src
39tar -xvzf kwave-0.9.3-1.tar.bz2
40mkdir kwave-build
41cd kwave-build
42cmake ../kwave-0.9.3
43
44make
45make install
46
472. RPM-SUPPORT:
48==============
49
50You can build nice binary and/or source rpm packages of kwave in one
51of the following ways. Note: Either you do everything as root or you
52must have write permissions in the following directories:
53
54* /tmp
55* /usr/src/packages/BUILD
56* /usr/src/packages/RPMS
57* /usr/src/packages/SOURCES
58* /usr/src/packages/SPECS
59* /usr/src/packages/SRPMS
60
61Installing the rpm package normally requires root permissions.
62
632.1 Building a binary rpm from archive file:
64-------------------------------------------
65
66Simply get the source archive (for example kwave-0.9.3-1.tar.bz2) and
67then type:
68
69rpmbuild -ta kwave-0.9.3-1.tar.bz2
70
71If you want to build for a different architecture than your current, you
72might want to add the parameter "--target ...", for example:
73
74rpmbuild -ta --target i586 kwave-0.9.3-1.tar.bz2
75
76compiles for i586 architecture.
77
78
792.2 Building a source and binary rpm from the source tree (GIT):
80---------------------------------------------------------------
81
82Assuming that you already have unpacked the source archive in some
83directory, like in chapter 1, but instead of the combination
84"make" / "make install" you do
85
86make src_rpm (and you get only a source rpm)
87***OR***
88make rpm (and you get both, a binary and a source rpm)
89
90Instructions on how to get the sources via GIT can be found in the
91Kwave handbook and on the Kwave project homepage at SourceForge
92(see "http://sourceforge.net/p/kwave/code/ci/master/tree/").
93
94Please note that the online documentation in not included in GIT, it will
95created from the corresponding docbook source which is included.
96This requires a working docbook/sgml environment that is sometimes
97problematic (see below).
98
99
1003. RELOCATING THE BINARY RPM:
101============================
102
103The binary rpm package of kwave is "relocatable". This means that you can
104build the package on a system with the KDE base directory set to some
105location (like for example /usr) and install it on some other system
106and/or into a different directory.
107
108rpm -Uvh --prefix=/usr/local kwave-0.9.3-1.i586.rpm
109
110This modifies the path where the program is installed and it is strongly
111recommended that this is a directory that is contained in the KDEDIRS
112environment variable, otherwise Kwave would be unable to find it's menu
113configuration, plugins, preset files and so on...
114
1154. REQUIREMENTS:
116===============
117
118>>> Please read the preface (section 0) before this <<<
119
120The revision codes (numbers after the '-') should not be so important.
121As a rule of thumb one can say that the nearer your version number is
122the better it will work.
123
124For compilation you need a working autoconf/automake environment, a good
125C/C++ compiler, the qt and the kde libraries.
126
127I am currently developing under a Gentoo Linux distribution
128(i586 architecture) using at least the following packages:
129
130* cmake >= 2.8.12 (the cmake build system)
131* gcc >= 4.7 (the C / C++ compiler)
132
133* make >= 3.80
134* libstdc++-v3 >= 3.3.4 (C++ library, including STL)
135* glibc >= 2.3 (the GNU C library)
136* kernel-headers (needed by glibc-devel)
137* gettext >= 0.12 (for internationalization)
138* rpm >= 4.0 (optional, for rpm support)
139* ImageMagick >= 6.1 (needed to create scaled Kwave icons)
140
141* libmad + libmad-devel >= 0.15 (for MP3 import)
142* id3lib >= 3.8.1 (for MP3 tag import, see www.id3lib.org)
143* libogg >= 1.1.2 (for Ogg/Vorbis import/export)
144* libvorbis >= 1.1.0 (for Ogg/Vorbis import/export)
145* flac >= 1.2.0 (for FLAC import/export)
146* fftw >= 3.0 (for Sonagram plugin / FFT)
147* pulseaudio >= 0.9.16 (for record/playback via PulseAudio)
148* samplerate >= 0.1.3 (for sample rate conversion)
149* gettext (for msgmerge)
150
151Some tools that are normally installed in every distribution:
152* sed, bash, msgcat, msgmerge, msgfmt, xgettext, cat, find, bzip2, perl
153
154Nearly everything from ftp.kde.org, especially the following
155packets should be sufficient for building:
156
157[WARNING: this list might be a bit outdated]
158
159* the following Qt packages Qt >= 5.14
160 - qtcore
161 - qtconcurrent
162 - qtnetwork
163 - qtgui
164 - qtmultimedia
165 - qtwidgets
166* the following KDE Frameworks packages, KF5 >= 5.33
167 - extra-cmake-modules
168 - kconfig
169 - kconfigwidgets
170 - kcoreaddons
171 - kcrash
172 - kdbusaddons
173 - kdoctools
174 - ki18n
175 - kiconthemes
176 - kio
177 - kservice
178 - ktextwidgets
179 - kxmlgui
180 - kwidgetsaddons
181
182 additionally, for generating the online help;
183
184 - poxml (for po2xml and xml2pot)
185 - kdoctools (for checkXML5)
186
187known distributions / architectures:
188------------------------------------
189
190see the Kwave homepage: http://kwave.sf.net/distributions.html
191
192Compilation might also work on many other distributions and different
193versions of compilers and libraries, or even on different architectures.
194
195So if you have success in compiling and using kwave under a different system,
196please let me know !
197
198If the program does NOT compile, please let me know too - and/or consider
199an update of your system if your packages are older than those mentioned
200above.
201
202currently tested distributions:
203-------------------------------------------
204
205see http://kwave.sourceforge.net/distributions.html
206
2075. KNOWN PROBLEMS / SOME HINTS:
208==============================
209
210* missing files:
211 -------------
212 Depending on your distribution, one ore more components might require
213 additional packages. Often you will need the "-devel" packages for
214 building (only) Kwave, e.g. it might not be sufficient to have the
215 package "libaudiofile" installed, additionally the corresponding package
216 "audiofile-devel" might be required too!
217
218 Hint for SuSE users:
219 => on CD1 (or on the DVD1) there is a file named "ARCHIVES.gz".
220 If you want to find out which package does contain a missing program or
221 file, you can do the following:
222
223 gzip -dc ARCHIVES.gz | grep name_of_the_missing_file
224
225* warnings about invalid character set when creating online documentation:
226 -----------------------------------------------------------------------
227 This is quite "normal", because some tools are not aware of the
228 UTF-8 encoding that is used in the .docbook and the .po files.
229
230* hint: compiling in parallel with distcc:
231 ---------------------------------------
232 I successfully compiled Kwave on many systems with the following
233 method:
234
235 CC=distcc CXX="distcc g++" cmake ...your parameters...
236 make -j <JOBS>
237
238 (replace <JOBS> with a number of parallel jobs, for example the
239 number of CPUs on all hosts + number of distcc hosts)
240
2416. SOME HISTORY:
242===============
243
244This project has been started by Martin Wilz in summer 1998 and has been
245developed and improved by him an some other people. In November 1999 I started
246to fix some little bugs here and there and stepped into the source code of
247the program deeper and deeper. Up to today I have extended, rewritten or
248revised nearly every component of the program and spend much time on it.
249Since summer 1999 I have taken over the project leadership and I am still
250working on it.
251
252So good luck, and feel free to keep me informed about bugs and wishes...
253
254 Thomas Eschenbacher <Thomas.Eschenbacher@gmx.de>
255
256