Merge branch 'master' of git://git.savannah.gnu.org/lilypond.git

[lilypond.git] / Documentation / contributor / quick-start.itexi

diff --git a/Documentation/contributor/quick-start.itexi b/Documentation/contributor/quick-start.itexi
index 4d014836a425f0f504302c92b28119a906f086aa..d12ff3578d649c0606e0d74cca5764098a483e1b 100644 (file)
--- a/Documentation/contributor/quick-start.itexi
+++ b/Documentation/contributor/quick-start.itexi
@@ -29,7 +29,8 @@ helpful users who may have never created a patch before.}
 @node Lilydev
 @section Lilydev
 
-text.
+This section discusses how to install and use the Ubuntu LilyPond
+Development Remix.
 
 @menu
 * Installing lilydev::
@@ -58,17 +59,19 @@ Download the Ubuntu LilyPond Developer Remix disk image:
 (approximately 1 GB)
 
 @example
-@uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.0.iso}
+@uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.1.iso}
 @end example
 
 @advanced{Some users might want these files, but if you don't
 recognize what they are, then you don't want them:
-@uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.0.iso.md5}
-@uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.0.iso.torrent}
+@*
+@uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.1.iso.md5}
+@c @*
+@c @uref{http://files.lilynet.net/ubuntu-lilydev-remix-1.0.iso.torrent}
 }
 
 @item
-Create a new @qq{virtual machine} inside your virtualization
+Create a music new @qq{virtual machine} inside your virtualization
 software.
 
 If possible, use at least 700 MB of RAM (1GB would be better) for
@@ -77,14 +80,14 @@ for the virtual hard drive.  A complete compile of everything
 (code, docs, regression tests) can reach 10 GB.
 
 @item
-Install @file{lilydev2.iso} as the @qq{guest} operating system
-on your virtualized system.
+Install @file{ubuntu-lilydev-remix-1.1.iso} as the @qq{guest}
+operating system on your virtualized system.
 
 @enumerate
 
 @item
-When @file{lilydev2.iso} boots, it shows an ISOLINUX
-@code{boot:} prompt.  Type:
+When @file{ubuntu-lilydev-remix-1.1.iso} boots, it shows an
+ISOLINUX @code{boot:} prompt.  Type:
 
 @example
 install
@@ -98,7 +101,7 @@ At the @qq{Prepare disk space} stage, do not be afraid to select
 @item
 When prompted to remove the installation CD, go to
 @clicksequence{Devices @click{} CD/DVD Devices} and de-select
-@file{lilydev2.iso}.
+@file{ubuntu-lilydev-remix-1.1.iso}.
 
 @end enumerate
 
@@ -125,7 +128,12 @@ client.
 
 Not all hardware is supported in all virtualization tools.  In
 particular, some contributors have reported problems with USB
-devices.  If you would like to investigate further, then look for
+devices, for example USB network adapters.  If you have problems
+with network connection (for example internet connection in the 
+host system is lost when you launch virtual system), try installing
+and running Lilydev with your computer's built-in network adapter 
+used to connect to the network.
+If you would like to investigate further, then look for
 help for your virtualization tool using your normal OS as the
 @qq{host} and Ubuntu as the @qq{client}.
 
@@ -259,6 +267,11 @@ directory (around 55Mb).  When the process is finished, the
 @qq{Command output} window will display @qq{Done}, and the button
 label will change to say @qq{Update source}.
 
+@warning{Some contributors have reported that nothing happens at
+this step.  If this occurs, then try again in a few minutes -- we
+suspect that this is an intermittant network problem.  If the
+problem persists, please ask for help.}
+
 @item
 Navigate to the @file{lilypond-git/} directory to view the source
 files.
@@ -435,6 +448,7 @@ will likely take 2 to 10 hours.
 
 @example
 cd ~/lilypond-git/build/
+make
 make doc
 @end example
 
@@ -446,13 +460,7 @@ you bookmark the resulting page:
 firefox ~/lilypond-git/build/out-www/offline-root/index.html
 @end example
 
-@subsubheading Other options
-
-To select different build options, or isolate certain parts of the
-build, or to use multiple CPUs while building, read the rest of
-this chapter.
-
-@subsubheading Installing LilyPond with lilydev
+@subsubheading Installing
 
 Don't.  There is no reason to install lilypond within lilydev.
 All development work can (and should) stay within the
@@ -460,6 +468,17 @@ All development work can (and should) stay within the
 or typesetting work should be done with an official GUB release.
 
 
+@subsubheading Problems and other options
+
+To select different build options, or isolate certain parts of the
+build, or to use multiple CPUs while building, read
+@ref{Compiling}.
+
+In particular, contributors working on the documentation should be
+aware of some bugs in the build system, and should read the
+workarounds in @ref{Generating documentation}.
+
+
 @node Now start work!
 @section Now start work!
 
@@ -467,11 +486,22 @@ Lilydev users may now skip to the chapter which is aimed at
 their intended contributions:
 
 @itemize
-@item @rcontrib{Documentation work}
-@item @rcontrib{Translating the documentation}
-@item @rcontrib{Website work}
-@item @rcontrib{Regression tests}
-@item @rcontrib{Programming work}
+@item @ref{Documentation work}
+@item @ref{Translating the documentation}
+@item @ref{Website work}
+@item @ref{Regression tests}
+@item @ref{Programming work}
+@end itemize
+
+These chapters are mainly intended for people not using LilyDev,
+but they contain extra information about the
+@qq{behind-the-scenes} activities.  We recommend that you read
+these at your leisure, a few weeks after beginning work with
+LilyDev.
+
+@itemize
+@item @ref{Working with source code}
+@item @ref{Compiling}
 @end itemize