OSDN Git Service

Manual: Added installations instructions for the ZIP package.
authorLoRd_MuldeR <mulder2@gmx.de>
Tue, 23 Dec 2014 14:10:05 +0000 (15:10 +0100)
committerLoRd_MuldeR <mulder2@gmx.de>
Tue, 23 Dec 2014 14:10:05 +0000 (15:10 +0100)
doc/Manual.html
doc/Manual.md
doc/img/lamexp/setup_2a.png [new file with mode: 0644]
doc/img/lamexp/setup_2b.png [new file with mode: 0644]
doc/img/lamexp/setup_2c.png [new file with mode: 0644]
doc/img/lamexp/setup_3b.png

index 3b29e96..07a3333 100644 (file)
@@ -165,10 +165,11 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.</code></pre>
 <p> <br /><strong>Addendum:</strong> When distributing binaries of the LameXP software, it is <em>strictly forbidden</em> to bundle the LameXP program files and/or the LameXP installation program with any kind of <em>Adware</em>, <em>Spyware</em> or <em>PUP (potentially unwanted program)</em>, including, but not limited to, any downloaders, dialers, browser toolbars/extensions or restricted shareware/demo programs. It is, however, perfectly legitimate to bundle LameXP with other <em>OpenSource</em> programs, according to the OSI (Open Source Initiative). Finally, it is also legitimate to bundle LameXP with <em>commercial software</em>, as long as that software does <em>not</em> meet the criteria of <em>Adware</em>, <em>Spyware</em> or <em>PUP</em>. If you bundle the LameXP software with another software, you are <em>required</em> to make sure that the user is provided with an easy way to install and start the LameXP software separately from that other software.</p>
 <h1 id="install-instructions"><span class="header-section-number">3</span> Install Instructions</h1>
+<p>This chapter explains how to install the LameXP software on your computer. If LameXP has already been installed on your computer, you may skip this chapter.</p>
 <h2 id="install-the-lamexp-software"><span class="header-section-number">3.1</span> Install the LameXP Software</h2>
-<p>The LameXP software is provided in two different forms: a self-running <strong>setup program</strong> and a <strong>ZIP package</strong>. For regular users, using the <em>setup program</em> is highly recommended!</p>
+<p>Distribution packages of the LameXP software is provided in two different flavours: a self-running <strong>setup program</strong> and a <strong>ZIP package</strong>. For regular users, using the <em>setup program</em> is highly recommended!</p>
 <h3 id="setup-program"><span class="header-section-number">3.1.1</span> Setup Program</h3>
-<p>In order to start the installation process, simply double-click on the LameXP setup program, e.g. <code>LameXP.yyyy-mm-dd.Release-Static.Build-xxxx.exe</code>.</p>
+<p>In order to start the installation process, simply double-click on the downloaded LameXP <strong>setup program</strong>, e.g. <code>LameXP.yyyy-mm-dd.Release-Static.Build-xxxx.exe</code>.</p>
 <p><em>Note:</em> Shortly after launching the setup program, an <a href="http://en.wikipedia.org/wiki/User_Account_Control">UAC</a> (User Access Control) dialogue may appear. This is a standard Windows security feature, so don't worry! You have to choose &quot;Yes&quot;, if you wish to continue the installation process.</p>
 <p><img src="img/lamexp/setup_1a.png" alt="Figure" /></p>
 <p> <br />Now simply follow the instructions of the setup wizard, which will guide you through the installation process…</p>
@@ -178,7 +179,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.<
 <p><em>Note:</em> If you keep the &quot;Run LameXP …&quot; option enabled and click on the &quot;Finish&quot; button, the LameXP software will be launched immediately.</p>
 <p><img src="img/lamexp/setup_1c.png" alt="Figure" /></p>
 <h3 id="zip-package"><span class="header-section-number">3.1.2</span> ZIP Package</h3>
-<p><strong>TODO</strong></p>
+<p>If you decided for the <strong>ZIP package</strong>, you need to open the downloaded ZIP file, e.g. <code>LameXP.yyyy-mm-dd.Release-Static.Build-xxxx.zip</code>, in your favourite file archive software (we recommend using <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/download.htm">WinRAR</a>).</p>
+<p><img src="img/lamexp/setup_2a.png" alt="Figure" /></p>
+<p> <br />This step may be slightly different, depending on what file archive software (e.g. 7-Zip or WinRAR) you are using. Select <strong>all</strong> files in the LameXP ZIP archive and <em>extract</em> them to a new/empty directory of your choice.</p>
+<p><em>Note:</em> It is very important that you have write-access to the chosen destination directory. So make sure that you choose a directory where the required access rights are granted!</p>
+<p><img src="img/lamexp/setup_2b.png" alt="Figure" /></p>
+<p> <br />Congratulation, LameXP has been installed successfully on your computer! Now double-click on the <code>LameXP.exe</code> program file in order to launch the application!</p>
+<p><img src="img/lamexp/setup_2c.png" alt="Figure" /></p>
 <h2 id="install-the-aac-encoder"><span class="header-section-number">3.2</span> Install the AAC Encoder</h2>
 <p>For legal reasons, the AAC (Advanced Audio Coding) encoder can <strong>not</strong> be included in the official LameXP distribution packages. Therefore, you need to download and install the AAC encoder <em>manually</em>.</p>
 <p>LameXP can use the <em>Nero Digital</em> AAC encoder as well as the <em>Apple</em> (iTunes/QucikTime) AAC encoder. This chapter describes how to set up these AAC encoder for use with LameXP.</p>
@@ -190,7 +197,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.<
 <p> <br />Simply scroll down, click the &quot;I agree&quot; button, and enter <code>user@example.com</code> when asked for an e-mail address. Finally, click the &quot;Download&quot; button, which initates the download of the required <code>NeroAACCodec-1.5.1.zip</code> file.</p>
 <p><em>Note:</em> Although the ZIP file is called <code>NeroAACCodec-1.5.1.zip</code>, it actually contains version <strong>1.5.4.0</strong> of the Nero AAC encoder software. Please check the included <code>changelog.txt</code> to verify this!</p>
 <p><img src="img/lamexp/setup_3a.png" alt="Figure" /></p>
-<p> <br />Now open the downloaded ZIP file with your favourite file archive software (we recommend using <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/download.htm">WinRar</a>) and navigate to the &quot;win32&quot; sub-directory.</p>
+<p> <br />Now open the downloaded ZIP file with your favourite file archive software (we recommend using <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/download.htm">WinRAR</a>) and navigate to the &quot;win32&quot; sub-directory.</p>
 <p><img src="img/lamexp/setup_3b.png" alt="Figure" /></p>
 <p> <br />Finally, <em>extract</em> all the three files <code>neroAacDec.exe</code>, <code>neroAacEnc.exe</code> and <code>neroAacTag.exe</code> into the LameXP installation directory. That is the directory where your LameXP executable file, i.e. <code>LameXP.exe</code>, is located.</p>
 <p><em>Note:</em> By default, the LameXP installation directory is either <code>C:\Program Files (x86)\MuldeR\LameXP</code> or <code>C:\Program Files\MuldeR\LameXP</code>. However, this can be changed by the user during the setup process.</p>
@@ -203,7 +210,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.<
 <h2 id="source-files"><span class="header-section-number">4.1</span> Source Files</h2>
 <p>First of all, you need to add all <strong>source files</strong> that you want to convert. So switch to the &quot;Source Files&quot; tab, just in case that tab is not active already, and then click the &quot;Add File(s)&quot; button.</p>
 <p><img src="img/lamexp/tutorial_1a.png" alt="Figure" /></p>
-<p> <br />This will bring up a standard file selection dialogue. Now simply select the files that you want to add and click the &quot;Open&quot; button. You can repeat this step multiple, e.g. to add files from different directories.</p>
+<p> <br />This will bring up a standard file selection dialogue. Now simply select the files that you want to add and click the &quot;Open&quot; button. You can repeat this step multiple times, e.g. to add files from different directories.</p>
 <p><img src="img/lamexp/tutorial_1b.png" alt="Figure" /></p>
 <p> <br />All files you have added, so far, will show up in the list. You can click the &quot;Remove&quot; button to remove a single file from the list or &quot;Clear&quot; to remove them all. Click the &quot;Show details&quot; button to show details about a file.</p>
 <p><img src="img/lamexp/tutorial_1c.png" alt="Figure" /></p>
index 2a67046..f041207 100644 (file)
@@ -131,16 +131,17 @@ LameXP is [*free software*](http://en.wikipedia.org/wiki/Free_software_movement)
 Install Instructions
 ====================
 
+This chapter explains how to install the LameXP software on your computer. If LameXP has already been installed on your computer, you may skip this chapter.
 
 Install the LameXP Software
 ---------------------------
 
-The LameXP software is provided in two different forms: a self-running **setup program** and a **ZIP package**. For regular users, using the *setup program* is highly recommended!
+Distribution packages of the LameXP software is provided in two different flavours: a self-running **setup program** and a **ZIP package**. For regular users, using the *setup program* is highly recommended!
 
 
 ### Setup Program ###
 
-In order to start the installation process, simply double-click on the LameXP setup program, e.g. ``LameXP.yyyy-mm-dd.Release-Static.Build-xxxx.exe``.
+In order to start the installation process, simply double-click on the downloaded LameXP **setup program**, e.g. ``LameXP.yyyy-mm-dd.Release-Static.Build-xxxx.exe``.
 
 *Note:* Shortly after launching the setup program, an [UAC](http://en.wikipedia.org/wiki/User_Account_Control) (User Access Control) dialogue may appear. This is a standard Windows security feature, so don't worry! You have to choose "Yes", if you wish to continue the installation process.
 
@@ -163,7 +164,21 @@ Congratulation, LameXP has been installed successfully on your computer!
 
 ### ZIP Package ###
 
-**TODO**
+If you decided for the **ZIP package**, you need to open the downloaded ZIP file, e.g. ``LameXP.yyyy-mm-dd.Release-Static.Build-xxxx.zip``, in your favourite file archive software (we recommend using [7-Zip](http://www.7-zip.org/) or [WinRAR](http://www.rarlab.com/download.htm)).
+
+![Figure](img/lamexp/setup_2a.png)
+
+&nbsp;  
+This step may be slightly different, depending on what file archive software (e.g. 7-Zip or WinRAR) you are using. Select **all** files in the LameXP ZIP archive and *extract* them to a new/empty directory of your choice.
+
+*Note:* It is very important that you have write-access to the chosen destination directory. So make sure that you choose a directory where the required access rights are granted!
+
+![Figure](img/lamexp/setup_2b.png)
+
+&nbsp;  
+Congratulation, LameXP has been installed successfully on your computer! Now double-click on the ``LameXP.exe`` program file in order to launch the application!
+
+![Figure](img/lamexp/setup_2c.png)
 
 
 Install the AAC Encoder
@@ -187,7 +202,7 @@ Simply scroll down, click the "I agree" button, and enter ``user@example.com`` w
 ![Figure](img/lamexp/setup_3a.png)
 
 &nbsp;  
-Now open the downloaded ZIP file with your favourite file archive software (we recommend using [7-Zip](http://www.7-zip.org/) or [WinRar](http://www.rarlab.com/download.htm)) and navigate to the "win32" sub-directory.
+Now open the downloaded ZIP file with your favourite file archive software (we recommend using [7-Zip](http://www.7-zip.org/) or [WinRAR](http://www.rarlab.com/download.htm)) and navigate to the "win32" sub-directory.
 
 ![Figure](img/lamexp/setup_3b.png)
 
@@ -222,7 +237,7 @@ First of all, you need to add all **source files** that you want to convert. So
 ![Figure](img/lamexp/tutorial_1a.png)
 
 &nbsp;  
-This will bring up a standard file selection dialogue. Now simply select the files that you want to add and click the "Open" button. You can repeat this step multiple, e.g. to add files from different directories.
+This will bring up a standard file selection dialogue. Now simply select the files that you want to add and click the "Open" button. You can repeat this step multiple times, e.g. to add files from different directories.
 
 ![Figure](img/lamexp/tutorial_1b.png)
 
diff --git a/doc/img/lamexp/setup_2a.png b/doc/img/lamexp/setup_2a.png
new file mode 100644 (file)
index 0000000..c16aee1
Binary files /dev/null and b/doc/img/lamexp/setup_2a.png differ
diff --git a/doc/img/lamexp/setup_2b.png b/doc/img/lamexp/setup_2b.png
new file mode 100644 (file)
index 0000000..9537b04
Binary files /dev/null and b/doc/img/lamexp/setup_2b.png differ
diff --git a/doc/img/lamexp/setup_2c.png b/doc/img/lamexp/setup_2c.png
new file mode 100644 (file)
index 0000000..bcad6b4
Binary files /dev/null and b/doc/img/lamexp/setup_2c.png differ
index 60563c2..664ffa8 100644 (file)
Binary files a/doc/img/lamexp/setup_3b.png and b/doc/img/lamexp/setup_3b.png differ