CG: compiling with lilybuntu.

diff --git a/Documentation/contributor/source-code.itexi b/Documentation/contributor/source-code.itexi
index 3223dfb9b31613e4124ad70f7d056f169c928c27..a7c1e5efe16145761d02f6318930a345724e872f 100644 (file)
--- a/Documentation/contributor/source-code.itexi
+++ b/Documentation/contributor/source-code.itexi
@@ -65,7 +65,11 @@ your normal text editor.
 
 @end enumerate
 
-You should now progress to @ref{Compiling}.
+You should now progress to @ref{Compiling with lilybuntu}.
+
+@warning{Throughout the rest of this manual, most command-line
+input should be entered from @file{~/lilypond-git/}.  This is
+referred to as the @emph{top source directory}.}
 
 
 @subsubheading Other operating music systems
@@ -318,7 +322,7 @@ need to access it, but it's good to know it's there.
 @warning{Throughout the rest of this manual, all command-line
 input should be entered from the top directory of the Git
 repository being discussed (eg. @file{~/lilypond-git/}).  This is
-referred to as a @emph{top source directory}.}
+referred to as the @emph{top source directory}.}
 
 Before downloading a copy of the main LilyPond repository, you
 should configure some basic settings with the

diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi
index 5c4db5807c9698f735200158d2cbf29828e4f1fc..67fee8e2075d061321584beed35a317998145ae1 100644 (file)
--- a/Documentation/included/compile.itexi
+++ b/Documentation/included/compile.itexi
@@ -7,8 +7,8 @@
 @c   @n ode Compiling from source
 @c   @s ection Compiling from source
 
-
 @menu
+* Compiling with lilybuntu::
 * Overview of compiling::
 * Requirements::
 * Getting the source code::
@@ -21,6 +21,85 @@
 @end menu
 
 
+@node Compiling with lilybuntu
+@section Compiling with lilybuntu
+
+Lilybuntu is our @q{remix} of Ubuntu which contains all the
+necessary dependencies to do lilypond development; for more
+information, see @rcontrib{Lilybuntu}.
+
+@subsubheading Preparing the build
+
+To prepare the build directory, enter (or copy&paste) the below
+text.  This should take less than a minute.
+
+@example
+cd ~/lilypond-git/
+sh autogen.sh --noconfigure
+mkdir -p build/
+cd build/
+../configure
+@end example
+
+@advanced{this is called an @qq{out-of-tree} build; we heavily
+recommend this build method.}
+
+@subsubheading Building @code{lilypond}
+
+Compiling lilypond will likely take between 5 and 30 minutes,
+depending on your computer's speed and available RAM.  We
+recommend that you minimize the terminal window while it is
+building; this can have a non-negligible effect on compilation
+speed.
+
+@example
+cd ~/lilypond-git/build/
+make
+@end example
+
+You may run the compiled @code{lilypond} with:
+
+@example
+cd ~/lilypond-git/build/
+out/bin/lilypond my-file.ly
+@end example
+
+@subsubheading Building the documentation
+
+Compiling the documentation is a much more involved process, and
+will likely take 45 minutes to 4 hours.
+
+@example
+cd ~/lilypond-git/build/
+make doc
+@end example
+
+The documentation is put in @file{out-www/offline-root/}.  You may
+view the html files by entering the below text; we recommend that
+you bookmark the resulting page:
+
+@example
+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.
+
+Lilybuntu users may now skip to the chapter which is aimed at
+their intended contributions:
+
+@itemize
+@item @rcontrib{Documentation work}
+@item @rcontrib{Translate the documentation}
+@item @rcontrib{Website work}
+@item @rcontrib{Regression tests}
+@item @rcontrib{Programming work}
+@end itemize
+
+
 @node Overview of compiling
 @section Overview of compiling