[kde-doc-english] [kwave] doc/en: updated handbook to reflect the port to Qt5/KF5 and partial migration from SourceForge to KDE servers
Thomas Eschenbacher
Thomas.Eschenbacher at gmx.de
Thu Jan 28 18:57:48 UTC 2016
Git commit 12c0a73a5474b50ba7f2ee5e1a3bbfc3ddce90c2 by Thomas Eschenbacher.
Committed on 28/01/2016 at 18:57.
Pushed by eschenbacher into branch 'master'.
updated handbook to reflect the port to Qt5/KF5 and partial migration from SourceForge to KDE servers
M +34 -27 doc/en/index.docbook
http://commits.kde.org/kwave/12c0a73a5474b50ba7f2ee5e1a3bbfc3ddce90c2
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
index a9d0348..9c350fa 100644
--- a/doc/en/index.docbook
+++ b/doc/en/index.docbook
@@ -17,6 +17,7 @@
<!ENTITY url_flac "http://flac.sourceforge.net/">
<!ENTITY url_homepage "http://kwave.sourceforge.net/">
<!ENTITY url_id3lib "http://id3lib.sourceforge.net/">
+ <!ENTITY url_kde_project "http://projects.kde.org/projects/kdereview/kwave">
<!ENTITY url_lame "http://lame.sourceforge.net/">
<!ENTITY url_levelmeter "https://web.archive.org/web/*/http://www.rikkus.info/esound-level-meter/">
<!ENTITY url_libaudiofile "http://www.68k.org/~michael/audiofile/">
@@ -29,8 +30,8 @@
<!ENTITY url_rfc2361 "http://www.ietf.org/rfc/rfc2361.txt">
<!ENTITY url_sourceforge "http://sourceforge.net">
<!ENTITY url_sox "http://sox.sourceforge.net/">
- <!ENTITY url_git_instructions "http://sourceforge.net/p/kwave/code/">
- <!ENTITY url_git_web "http://sourceforge.net/p/kwave/code/commit_browser">
+ <!ENTITY url_git_web_kde "http://quickgit.kde.org/?p=kwave.git">
+ <!ENTITY url_git_web_sf "http://sourceforge.net/p/kwave/code/commit_browser">
<!ENTITY url_git_list_tags "http://sourceforge.net/p/kwave/code/ref/master~/tags/">
<!ENTITY url_git_master "git://git.code.sf.net/p/kwave/code">
<!ENTITY i18n-cmd_syntax "Syntax: ">
@@ -347,7 +348,7 @@
<chapter id="introduction"><title>Introduction</title>
<para>
- This is "&kwave;", a simple sound editor for KDE-4.
+ This is "&kwave;", a simple sound editor for KDE Frameworks 5.
Its features include:
<itemizedlist>
<listitem><para>
@@ -372,16 +373,16 @@
Recording functionality, including pre-recording
</para></listitem>
<listitem><para>
- Playback via ALSA and OSS
+ Playback via Qt, PulseAudio, ALSA and OSS
</para></listitem>
<listitem><para>
- Recording via ALSA and OSS
+ Recording via PulseAudio, ALSA and OSS
</para></listitem>
<listitem><para>
MP3 import/export
</para></listitem>
<listitem><para>
- Ogg/Vorbis import/export
+ Ogg/Vorbis and Opus import/export
</para></listitem>
<listitem><para>
FLAC import/export
@@ -400,7 +401,7 @@
</para></listitem>
<listitem><para>
playback of multi channel audio files (audio output will be
- mixed down to mono or stereo)
+ mixed down to mono or stereo if needed)
</para></listitem>
<listitem><para>
extendible through an easy-to-use plugin interface
@@ -450,15 +451,15 @@
GIT Repository<anchor id="git-repository"/>
</para>
<para>
- There also is a GIT repository, hosted by
+ There also is a new GIT repository hosted on KDE servers, and a
+ mirror repository hosted by
<ulink url="&url_sourceforge;">SourceForge</ulink> where
you can get the sources of the latest development version.
For instructions on how to get access to the repository, read
in the chapter about
- <link linkend="building_rpm_from_git">building from GIT</link>,
- or look at
- <ulink url="&url_git_instructions;">"&url_git_instructions;"</ulink>.
- There also is a nice <ulink url="&url_git_web;">web interface</ulink>
+ <link linkend="building_rpm_from_git">building from GIT</link>.
+ There also is a GIT web interface on <ulink url="&url_git_web_kde;">KDE</ulink>
+ and on <ulink url="&url_git_web_sf;">SourceForge</ulink> where
you can use to browse through the sources.
</para></listitem>
</itemizedlist>
@@ -488,7 +489,13 @@
you can find the full history here:
<ulink url="&url_changelog;"> &url_changelog;</ulink> or browse
through the sources on your own through the
- <ulink url="&url_git_web;">GIT web interface</ulink>.
+ <ulink url="&url_git_web_kde;">GIT web interface</ulink>.
+ </para>
+
+ <para>
+ &kwave; version v0.9.0 is the first version hosted on KDE (kdereview)
+ and SourceForge servers, followed by v0.9.1, the first version for
+ KDE Frameworks 5.
</para>
<!-- changelog cut out, this gives a smaller online help
@@ -516,6 +523,11 @@
information about current stable and up-to-date development
versions.
</para>
+ <para>
+ There also is a KDE project page
+ at <ulink url="&url_kde_project;">&url_kde_project;</ulink> which
+ is mostly interesting for developers.
+ </para>
<para>
If you want to get a &kwave; release, you have the choice to visit
@@ -540,8 +552,8 @@
<para>
Don't be afraid, compiling Kwave should be quite simple even if
- you are not a programmer. It just needs some developer packages
- to be installed.
+ you are not a software developer. It just needs some developer
+ packages to be installed and some time.
</para>
</sect1>
@@ -567,12 +579,12 @@
<emphasis>hear</emphasis> the result of your work?)
</para></listitem>
<listitem><para>
- KDE-4.5 or higher (at least the libraries, if you are
- a gnome fan, you can also run &kwave; if the proper
- libs are installed).
+ KDE Frameworks 5.2 (KF5) or higher (at least the libraries,
+ if you are using a different desktop, you can also run &kwave;
+ if the proper libraries are installed).
</para></listitem>
<listitem><para>
- Qt-4.7 or higher (normally comes with KDE4)
+ Qt-5.4 or higher (normally comes as a dependency of KF5)
</para></listitem>
<listitem><para>
ALSA 1.0.14 or higher (for record/playback)
@@ -607,11 +619,11 @@
If you intend to compile &kwave; from the sources, you will need at least:
<itemizedlist>
<listitem><para>
- <ulink url="&url_cmake;">cmake</ulink>-2.6.0 or newer
+ <ulink url="&url_cmake;">cmake</ulink>-2.8.12 or newer
</para></listitem>
<listitem><para>
A recent C/C++ compiler. GCC-4.x works fine, some older and any
- newer version (like gcc-5.0) may work too.
+ newer version (like gcc-5.0) should work too.
</para></listitem>
<listitem><para>
The glibc2 (libc-6) development environment. On SuSE systems
@@ -619,12 +631,7 @@
called "libc-devel".
</para></listitem>
<listitem><para>
- The KDE4 development environment: "kdelibs4-devel",
- "kdemultimedia4-devel", "kdesdk4".
- </para></listitem>
- <listitem><para>
- The Qt4 development environment,
- the package is normally called "qt4-devel" or similar.
+ Qt5 and KF5 development packages
</para></listitem>
<listitem><para>
pulseaudio-0.9.16 or newer
More information about the kde-doc-english
mailing list