[musicians-guide] standardized requirements and installation for DAWs

crantila crantila at fedoraproject.org
Wed Aug 4 06:20:31 UTC 2010


commit ce7670d542ac6fcf1c5e11e9faf1e240b80f7f63
Author: Christopher Antila <crantila at fedoraproject.org>
Date:   Wed Aug 4 02:20:08 2010 -0400

    standardized requirements and installation for DAWs

 en-US/Ardour.xml                      |   16 ++++---
 en-US/Audacity.xml                    |   72 +++++++++++++++-----------------
 en-US/Qtractor.xml                    |   25 +++++++----
 en-US/Rosegarden.xml                  |   34 +++++++--------
 en-US/SuperCollider/SuperCollider.xml |   21 ++++++----
 5 files changed, 88 insertions(+), 80 deletions(-)
---
diff --git a/en-US/Ardour.xml b/en-US/Ardour.xml
index 36d5aa3..b5e276d 100644
--- a/en-US/Ardour.xml
+++ b/en-US/Ardour.xml
@@ -14,28 +14,30 @@
 	<section id="sect-Musicians_Guide-Ardour-Requirements_and_Installation">
 		<title>Requirements and Installation</title>
 		
+		<section id="sect-Musicians_Guide-Qtractor-Knowledge_Requirements">
+			<title>Knowledge Requirements</title>
+			<para>
+				Ardour's user interface is similar to other DAWs.  We recommend that you read !!L!!common interface!!L!! if you have not used a DAW before.
+			</para>
+		</section>
 		<section id="sect-Musicians_Guide-Ardour-Software_Requirements">
 			<title>Software Requirements</title>
 			<para>
-				Ardour requires the use of the JACK Audio Connection Kit.  It is not possible to use Ardour with JACK.  If you have not already installed JACK, it is recommended that you do so before installing Ardour.  Instructions for installing JACK are available [[User:Crantila/FSC/Sound_Servers#Installing_JACK|here]].
+				Ardour uses the JACK Audio Connection Kit.  You should install JACK before installing Ardour.  Follow the instructions !!L!! here !!L!! to install JACK.
 			</para>
 		</section>
 		<section id="sect-Musicians_Guide-Ardour-Hardware_Requirements">
 			<title>Hardware Requirements</title>
 			<para>
-				In order to use Ardour, you will need an audio interface.  If you intend to record external audio with Ardour, your audio interface must be capable of recording, and you must have external hardware (such as microphones) to allow this recording.  If you intend to record only audio produced by other JACK-aware programs (such as FluidSynth or SuperCollider), then equipment such as microphones is not required.
+				You need an audio interface to use Ardour.  If you will record audio with Ardour, you must have at least one microphone connected to your audio interface.  You do not need a microphone to record audio signals from other JACK-aware programs like <code>FluidSynth</code> and <code>SuperCollider</code>.
 			</para>
 		</section>
 		<section id="sect-Musicians_Guide-Ardour-Installation">
 			<title>Installation</title>
 			<para>
-				If you have not already installed the JACK Audio Connection Kit, it is recommended that you do so before installing Ardour.  Instructions for installing JACK are available [[User:Crantila/FSC/Sound_Servers#Installing_JACK|here]].
-			</para>
-			<para>
-			After installing JACK, installing Ardour is as simple as using PackageKit or KPackageKit to install the "ardour" package, or running the following command in a terminal [pre]su -c 'yum install ardour'[/pre]
+				Use PackageKit or KPackageKit to install the "ardour" package.  Other required software is installed automatically.
 			</para>
 		</section>
-
 	</section>
 	
 	<section id="sect-Musicians_Guide-Ardour-Recording_a_Session">
diff --git a/en-US/Audacity.xml b/en-US/Audacity.xml
index 80a0193..36e2dd9 100644
--- a/en-US/Audacity.xml
+++ b/en-US/Audacity.xml
@@ -27,15 +27,23 @@
 	<section id="sect-Musicians_Guide-Audacity-Requirements_and_Installation">
 		<title>Requirements and Installation</title>
 		
-		<section id="sect-Musicians_Guide-Audacity-Requirements">
-			<title>Requirements</title>
+		<section id="sect-Musicians_Guide-Audacity-Software_Requirements">
+			<title>Software Requirements</title>
 			<para>
 				Audacity uses several "libraries."  Libraries are incomplete programs that add capabilities to other programs or applications.  Libraries can be shared between programs.  The libraries needed by Audacity will be installed automatically.
 			</para>
 			<para>
 				The version of Audacity from the Fedora repository does not use an MP3 library.  If you do not want to use MP3 files with Audacity, you should follow the !!L!!Standard Installation!!L!! instructions.  If you want to use MP3 files with Audacity, you should follow the !!L!!MP3-Enabled Instructions!!L!!.
 			</para>
-			<!-- Information about JACK no longer needed, since jack2 will be in Fedora 14 for sure -->
+			<para>
+				Audacity can use the JACK Audio Connection Kit.  You should install JACK before installing Audacity.  Follow the instructions !!L!! here !!L!! to install JACK.  We recommend using Audacity without JACK, but JACK is installed whether or not you use it.
+			</para>
+		</section>
+		<section id="sect-Musicians_Guide-Audacity-Hardware_Requirements">
+			<title>Hardware Requirements</title>
+			<para>
+				You need an audio interface to use Audacity.  If you will record audio with Audacity, you must have at least one microphone connected to your audio interface.  You do not need a microphone to edit existing audio files.
+			</para>
 		</section>
 		<section id="sect-Musicians_Guide-Audacity-Installation">
 			<title>Standard Installation</title>
@@ -62,44 +70,32 @@
 		</section>
 		<section id="sect-Musicians_Guide-Audacity-Testing_Playback">
 			<title>Post-Installation Testing: Playback</title>
-			<para>
-				<orderedlist>
-				<listitem><para>Locate an audio file that you want to use to test the playback.
-					<itemizedlist>
-					<listitem><para>Files in WAV or AIFF format will be the easiest to use at this point.</para></listitem>
-					<listitem><para>The file should not be especially quiet; you should easily be able to know whether it is playing correctly.</para></listitem>
-					<listitem><para>The file can be located anywhere on your computer, as long as you have permission to read it.</para></listitem>
-					<listitem><para>If you do not already have a file, you can use <code>/usr/share/sounds/alsa/Noise.wav</code>, which is intended for test purposes like these.</para></listitem>
-					</itemizedlist>
-					</para></listitem>
-				<listitem><para>After starting Audacity, you can find and select a file by selecting ''File > Open''.</para></listitem>
-				<listitem><para>Play the file repeatedly, as needed.  Adjust the volume levels on your speakers and audio interface, if necessary.</para></listitem>
-				<listitem><para>If playback does not work as intended, first verify that your hardware is setup correctly.  If it is, then verify that Audacity is setup correctly - see the !!L!!"Configuring Audacity to Use Your Hardware" section!!L!!.</para></listitem>
-				</orderedlist>
-			</para>
+			<procedure>
+				<step><para>Start Audacity.</para></step>
+				<step><para>Set the volume of your audio interface and speakers to a safe level.</para></step>
+				<step><para>Open the "Open File" window by clicking on 'File > Open'.</para></step>
+				<step><para>Open the <code>/usr/share/sounds/alsa/Noise.wav</code> file.  This file is designed for testing audio equipment.</para></step>
+				<step><para>Play the file as many times as you need.  Adjust the volume of your audio interface and speakers while the file is playing.</para></step>
+				<step><para>If you cannot hear sound when the file is played, check that your audio interface and speakers are correctly connected and powered on.</para></step>
+				<step><para>If you still cannot hear sound when the file is played, see the !!L!!"Configuring Audacity to Use Your Hardware" section!!L!!.</para></step>
+			</procedure>
 		</section>
 		<section id="sect-Musicians_Guide-Audacity-Testing_Recording">
 			<title>Post-Installation Testing: Recording</title>
-			<para>
-				<orderedlist>
-				<listitem><para>Set up your microphone (or other audio source) so that it is connected to the input of the sound card you are using.</para></listitem>
-				<listitem><para>Start Audacity with an empty session (no audio file is open).</para></listitem>
-				<listitem><para>In the toolbar, there should be two volume level meters.
-					<itemizedlist>
-					<listitem><para>During the playback test, one of them should display green bars.</para></listitem>
-					<listitem><para>The other one will display red bars, representing the input level from your audio interface.</para></listitem>
-					<listitem><para>If you do not see it, it may have been accidentally closed.  You can ensure that it is displayed by selecting ''View > Toolbars > Meter Toolbar''. There should be a check mark next to it.</para></listitem>
-					</itemizedlist>
-					</para></listitem>
-				<listitem><para>There is a small, downward-pointing arrow next to the microphone icon on the level meter.  Click the arrow, then choose ''Start Monitoring''.</para></listitem>
-				<listitem><para>Ensure that your source is producing an audio signal.  If your source is a microphone, then sing or talk into it.</para></listitem>
-				<listitem><para>The recording level meter should react to the input.</para></listitem>
-				<listitem><para>Press the ''Record'' button on the toolbar to start a test recording.</para></listitem>
-				<listitem><para>After a few seconds, press the ''Stop'' button on the toolbar to stop the test recording.</para></listitem>
-				<listitem><para>Press ''Play'' on the toolbar to start playing the test recording.  The playback should represent the sound that you wanted to record.</para></listitem>
-				<listitem><para>If recording does not work as intended, first verify that your hardware is setup correctly.  If it is, then verify that Audacity is setup correctly - see the "Configuring Audacity to Use Your Hardware" section.</para></listitem>
-				</orderedlist>
-			</para>
+			<procedure>
+				<step><para>Connect your microphones to your audio interface.</para></step>
+				<step><para>Start Audacity.  Do not open a file.</para></step>
+				<step><para>Locate the volume level meters on the toolbar, to the right of the transport controls.  If you do not see the meters, you can show them by clicking 'View > Toolbars > Meter Toolbar', which should have a check mark next to it.</para></step>
+				<step><para>Click the small, down-pointing arrow next to the microphone icon on the level meters.  Then click "Start Monitoring".</para></step>
+				<step><para>Sing, talk, or make noise into the microphone.  The volume level meter should show moving red bars.</para></step>
+				<step><para>Adjust the volume of the recording inputs on your audio interface.  When there is no noise, the moving red bars should be very small.</para></step>
+				<step><para>If you do not see moving red bars in the volume level meter, check that your audio interface and microphone are correctly connected and powered on.  If your equipment was not properly connected, adjust the volume of the recording inputs on your audio interface now.</para></step>
+				<step><para>If you still do not see moving red bars, see the !!L!!"Configuring Audacity to Use Your Hardware" section!!L!!.</para></step>
+				<step><para>Press the "Record" button to start a test recording.  Sing, talk, or make noise into the microphone.</para></step>
+				<step><para>After a few seconds, press the "Stop" button to stop the test recording.</para></step>
+				<step><para>Press the "Play" button to hear the recorded audio.</para></step>
+				<step><para>If the recording sounds bad, you might need to reconfigure Audacity.  See the !!L!!"Configuring Audacity to Use Your Hardware" section!!L!!.</para></step>
+			</procedure>
 		</section>
 		
 	</section>
diff --git a/en-US/Qtractor.xml b/en-US/Qtractor.xml
index 196332a..a9a3f0e 100644
--- a/en-US/Qtractor.xml
+++ b/en-US/Qtractor.xml
@@ -22,27 +22,34 @@
 		<section id="sect-Musicians_Guide-Qtractor-Knowledge_Requirements">
 			<title>Knowledge Requirements</title>
 			<para>
-				Although Qtractor is one of the simplest software-based DAWs currently available in Fedora Linux, its interface may not be straight-forward unless you have previous experience with DAW software.  Reading the [[ser:Crantila/FSC/Recording/DAW_Common_Elements|Common Elements]] chapter of this Guide will provide enough background information for you to use Qtractor, Ardour, and Rosegarden.
+				Qtractor is easy to use, and its user interface is similar to other DAWs.  We recommend that you read !!L!!common interface!!L!! if you have not used a DAW before.
 			</para>
 		</section>
-		<section id="sect-Musicians_Guide-Qtractor-Software_and_Hardware_Requirements">
-			<title>Software and Hardware Requirements</title>
+		<section id="sect-Musicians_Guide-Qtractor-Software_Requirements">
+			<title>Software Requirements</title>
 			<para>
-				If you have not already installed the JACK Audio Connection Kit, it is recommended that you do so before installing Ardour.  Instructions for installing JACK are available [[User:Crantila/FSC/Sound_Servers#Installing_JACK|here]].
+				Qtractor uses the JACK Audio Connection Kit.  You should install JACK before installing Qtractor.  Follow the instructions !!L!! here !!L!! to install JACK.
 			</para>
+		</section>
+		<section id="sect-Musicians_Guide-Qtractor-Hardware_Requirements">
+			<title>Hardware Requirements</title>
 			<para>
-				In addition to JACK, if you intend to use Qtractor for recording audio, your system's audio interface should be configured with microphones, as desired.  Your system's audio interface should also be configured for audio output, either with speakers, or preferably with headphones.  Headphones will allow you to listen to a session as it is recorded.
+				You need an audio interface to use Qtractor.  If you will record audio with Qtractor, you must have at least one microphone connected to your audio interface.  You do not need a microphone to record audio signals from other JACK-aware programs like <code>FluidSynth</code> and <code>SuperCollider</code>.
 			</para>
+		</section>
+		<section id="sect-Musicians_Guide-Qtractor-Other_Requirements">
+			<title>Other Requirements</title>
 			<para>
-				If you intend to use Qtractor for recording MIDI, then your system's MIDI interface should be configured with MIDI input devices, as desired.  If you intend to use Qtractor for sequencing and synthesizing MIDI signals into audio signals, then you will need a MIDI synthesizer.  Both hardware- and software-based MIDI synthesizers are compatible with Qtractor.  <code>FluidSynth</code> is a good, software-based MIDI synthesizer, and it is discussed in [[User:Crantila/FSC/Synthesizers/FluidSynth|this part]].
+				You need a MIDI synthesizer to use Qtractor as a MIDI sequencer.  You can use hardware-based and software-based synthesizers with Qtractor.  We recommend using the software-based <code>FluidSynth</code> MIDI synthesizer.  See !!L!! this section !!L!! for information about <code>FluidSynth</code>.
 			</para>
 		</section>
 		<section id="sect-Musicians_Guide-Qtractor-Installation">
 			<title>Installation</title>
 			<para>
-				!!I!! Qtractor may or may not be available from a standard Fedora repository in Fedora 14.  This assumes that it is. !!I!!
-				
-				You can install Qtractor either using the PackageKit or KPackageKit applications, or by running the following command in a terminal: [pre]su -c 'yum install qtractor'[/pre] If you will be using Qtractor with a SoundFont-compatible, software-based MIDI synthesizer (such as <code>FluidSynth</code>/QSynth), you should tell Qtractor about the SoundFont.  See the !!L!!"Configuring MIDI Channel Names"!!L!! section.  You can install the <code>FluidSynth</code>/QSynth synthesizer by following the instructions !!L!!here!!L!!.
+				Qtractor is not available from the Fedora software repositories.  Qtractor is available from the "Planet CCRMA at Home" and "RPM Fusion" repositories.  If you have already enabled one of those repositories, you should install Qtractor from that repository.  If you have not already enabled one of those repositories, we recommend that you install Qtractor from the "Planet CCRMA at Home" repository.  See !!L!! this section !!L!! for instructions that enable the "Planet CCRMA at Home" repository.  The "Planet CCRMA at Home" repository contains a wide variety of music and audio applications.
+			</para>
+			<para>
+				After you enable the "RPM Fusion" or "Planet CCRMA at Home" repository, use PackageKit or KPackageKit to install the "qtractor" packge.  Other required software is installed automatically.
 			</para>
 		</section>
 	</section>
diff --git a/en-US/Rosegarden.xml b/en-US/Rosegarden.xml
index 65b1fd5..23cb8fa 100644
--- a/en-US/Rosegarden.xml
+++ b/en-US/Rosegarden.xml
@@ -10,39 +10,37 @@
 	<section id="sect-Musicians_Guide-Rosegarden-Requirements_and_Installation">
 		<title>Requirements and Installation</title>
 		
-		<section id="sect-Musicians_Guide-Rosegarden-Hardware_and_Software_Requirements">
-			<title>Hardware and Software Requirements</title>
+		<section id="sect-Musicians_Guide-Qtractor-Knowledge_Requirements">
+			<title>Knowledge Requirements</title>
 			<para>
-				Rosegarden requires the JACK Audio Connection Kit, which helps it to connect to your audio hardware and other JACK-aware programs.   If you have not already installed JACK, it is recommended that you do so before installing Rosegarden.  Instructions for JACK installation are located [[User:Crantila/FSC/Sound_Servers#Installing_JACK|here]].
-			</para>
-			<para>
-				Rosegarden's graphical interface uses the "Qt toolkit," like the KDE Software Collection.  QjackCtl, Qsynth, and Qtractor also use the Qt toolkit, but if you have not installed any of these, and you are a GNOME user, Rosegarden may install the Qt toolkit.  The toolkit may take a while to download, but is useful for a large number of programs.
+				Rosegarden's user interface is similar to other DAWs.  We recommend that you read !!L!!common interface!!L!! if you have not used a DAW before.
 			</para>
+		</section>
+		<section id="sect-Musicians_Guide-Rosegarden-Software_Requirements">
+			<title>Software Requirements</title>
 			<para>
-				In order to use Rosegarden, you will need an audio interface.  If you wish to record audio into Rosegarden, the audio interface must be capable of recording, and you must have external hardware such as microphones to capture the sound.  Rosegarden is useful without recording audio.
+				Rosegarden uses the JACK Audio Connection Kit.  You should install JACK before installing Rosegarden.  Follow the instructions !!L!! here !!L!! to install JACK.
 			</para>
 		</section>
-		<section id="sect-Musicians_Guide-Rosegarden-Other_Requirements">
-			<title>Other Requirements</title>
-			<!-- CRA: I'll have to change this to be the same as in Qtractor (TODO) -->
+		<section id="sect-Musicians_Guide-Rosegarden-Hardware_Requirements">
+			<title>Hardware Requirements</title>
 			<para>
-				In addition to the above-listed requirements, you will need to install a MIDI-capable synthesizer.  Rosegarden does not automatically install a synthesizer so that you have the greatest amount of choice.  There are a large number of synthesizers, both hardware- and software-based, which all have different capabilities and produce different sounds.  Rosegarden is a "MIDI sequencer," meaning that it will trigger and control a MIDI synthesizer, but without synthesizing audio directly.
+				You need an audio interface to use Rosegarden.  If you will record audio with Rosegarden, you must have at least one microphone connected to your audio interface.  You do not need a microphone to record audio signals from other JACK-aware programs like <code>FluidSynth</code> and <code>SuperCollider</code>.
 			</para>
 			<para>
-				Most users, at least when starting out, will find that FluidSynth is a highly flexible synthesizer.  It is recommended by Rosegarden's "Welcome" screen, and it will be used here for demonstration purposes.  The [[User:Crantila/FSC/Synthesizers/FluidSynth|FluidSynth\Qsynth Chapter]] explains how to install and use FluidSynth, along with its graphical interface called Qsynth.
+				You need a MIDI synthesizer to use Rosegarden as a MIDI sequencer.  You can use hardware-based and software-based synthesizers with Rosegarden.  We recommend using the software-based <code>FluidSynth</code> MIDI synthesizer.  See !!L!! this section !!L!! for information about <code>FluidSynth</code>.
 			</para>
+		</section>
+		<section id="sect-Musicians_Guide-Rosegarden-Other_Requirements">
+			<title>Other Requirements</title>
 			<para>
-				In addition to independent MIDI synthesizers, Rosegarden supports the use of DSSI synthesizer plugins, which is not discussed in this Guide.
+				You need a MIDI synthesizer to use Rosegarden as a MIDI sequencer.  You can use hardware-based and software-based synthesizers with Rosegarden.  We recommend using the software-based <code>FluidSynth</code> MIDI synthesizer.  See !!L!! this section !!L!! for information about <code>FluidSynth</code>.
 			</para>
 		</section>
 		<section id="sect-Musicians_Guide-Rosegarden-Installation">
 			<title>Installation</title>
 			<para>
-				Before installing Rosegarden, you should install the JACK Audio Connection Kit.  If you have not already installed JACK, you can follow the instructions [[User:Crantila/FSC/Sound_Servers#Installing_JACK|here]].
-			</para>
-			<para>
-				To install Rosegarden, use PackageKit or KPackageKit to install the <code>rosegarden4</code> package.  You could also install Rosegarden from a terminal by running the following command:
-				[pre]su -c 'yum install rosegarden4'[/pre]
+				Use PackageKit or KPackageKit to install the "rosegarden4" packge.  Other required software is installed automatically.
 			</para>
 		</section>
 	</section> <!-- Ends "Requirements and Installation" Section -->
diff --git a/en-US/SuperCollider/SuperCollider.xml b/en-US/SuperCollider/SuperCollider.xml
index 12876e0..016dce7 100644
--- a/en-US/SuperCollider/SuperCollider.xml
+++ b/en-US/SuperCollider/SuperCollider.xml
@@ -48,14 +48,19 @@
 				<!-- Sourced from http://en.wikipedia.org/wiki/List_of_basic_computer_programming_topics -->
 			</para>
 		</section>
-		<section id="sect-Musicians_Guide-SC-Req_and_Inst-Hardware_and_Software">
-			<title>Software and Hardware Requirements</title>
+		<section id="sect-Musicians_Guide-SC-Req_and_Inst-Software_Requirements">
+			<title>Software Requirements</title>
 			<para>
-				<itemizedlist>
-				<listitem><para>Planet CCRMA at Home (see [[User:Crantila/FSC/CCRMA/Everything|these instructions]])</para></listitem>
-				<listitem><para>JACK (see [[User:Crantila/FSC/Sound_Servers#Installing_JACK|these instructions]])</para></listitem>
-				<listitem><para>JACK-capable audio interface</para></listitem>
-				</itemizedlist>
+				SuperCollider uses the JACK Audio Connection Kit.  You should install JACK before installing SuperCollider.  Follow the instructions !!L!! here !!L!! to install JACK.
+			</para>
+			<para>
+				SuperCollider is not available from the Fedora software repositories.  You must enable the "Planet CCRMA at Home" repository to install SuperCollider.  See !!L!! this section !!L!! for instructions that enable the "Planet CCRMA at Home" repository.  The "Planet CCRMA at Home" repository contains a wide variety of music and audio applications.
+			</para>
+		</section>
+		<section id="sect-Musicians_Guide-SC-Req_and_Inst-Hardware_Requirements">
+			<title>Hardware Requirements</title>
+			<para>
+				You need an audio interface to use SuperCollider.  You do not need a microphone to use SuperCollider.
 			</para>
 		</section>
 		<section id="sect-Musicians_Guide-SC-SC-Req_and_Inst-Available_Packages">
@@ -110,7 +115,7 @@
 		<section id="sect-Musicians_Guide-SC-Req_and_Inst-Recommended_Installation">
 			<title>Recommended Installation</title>
 			<para>
-				If you have never used SuperCollider before, then I recommend installing the smallest number of packages possible.  This will allow you to start learning with the core classes, available on all SuperCollider installations.  Installing the bare minimum requirements will not prevent you from installing optional libraries in the future, of course.
+				If you have never used SuperCollider before, then we recommend installing the smallest number of packages possible.  This will allow you to start learning with the core classes, available on all SuperCollider installations.  Installing the bare minimum requirements will not prevent you from installing optional libraries in the future, of course.
 			</para>
 			<para>
 				The recommended installation also avoids installing the "emacs" or "vim" components, which - unless you are already a programmer - you probably don't know how to use.  The "emacs" and "vim" text editors are extremely powerful and extensible, but they can be difficult to learn.  Furthermore, there's no reason to learn them just for SuperCollider, because the component for GEdit is more than sufficient.


More information about the docs-commits mailing list