]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/contributor/quick-start.itexi
CG: remove information about frogs and frog meister
[lilypond.git] / Documentation / contributor / quick-start.itexi
index a549c4ef5747156a4b2730b0965c50994f26b0c2..22ea0591b10c33022aea51adb0d93b9d956f9cd8 100644 (file)
@@ -17,7 +17,7 @@ for you and will help you do this as quickly and easily as possible.
 @node LilyDev
 @section LilyDev
 
 @node LilyDev
 @section LilyDev
 
-There is a disk image of a @q{remix} of Ubuntu Linux available for
+There is a disk image of a @q{remix} of Ubuntu GNU/Linux available for
 download which includes all the necessary software and tools to compile
 both LilyPond and the documentation.  Called the
 @qq{Ubuntu LilyPond Developer Remix}, but known simply as @qq{LilyDev}
 download which includes all the necessary software and tools to compile
 both LilyPond and the documentation.  Called the
 @qq{Ubuntu LilyPond Developer Remix}, but known simply as @qq{LilyDev}
@@ -25,27 +25,21 @@ for short.  Although it is not possible to compile LilyPond on Windows
 and extremely difficult on MacOS, LilyDev can be installed and run
 inside a @q{virtual machine} on any of these operating systems without
 disturbing your main operating system.  The LilyDev disk image can also
 and extremely difficult on MacOS, LilyDev can be installed and run
 inside a @q{virtual machine} on any of these operating systems without
 disturbing your main operating system.  The LilyDev disk image can also
-be burnt to a DVD and installed like any other Ubuntu Linux
+be burnt to a DVD and installed like any other Ubuntu GNU/Linux
 distribution.
 
 Most virtualization software can be used but we recommend VirtualBox as
 it is available for all major operating systems and is easy to install
 & configure.
 
 distribution.
 
 Most virtualization software can be used but we recommend VirtualBox as
 it is available for all major operating systems and is easy to install
 & configure.
 
-If you are not familiar with Linux, it may be beneficial to read a
+If you are not familiar with GNU/Linux, it may be beneficial to read a
 couple of @qq{introduction to Ubuntu} web pages.
 
 couple of @qq{introduction to Ubuntu} web pages.
 
-Some contributors have recommended a free PDF:
-
-@example
-@uref{http://www.ubuntupocketguide.com/}
-@end example
-
 For those interested, the LilyDev remix is currently based on a 32bit
 version of 10.04 LTS Ubuntu (Lucid Lynx).
 
 @warning{Apart from installing and configuring LilyDev in VirtualBox,
 For those interested, the LilyDev remix is currently based on a 32bit
 version of 10.04 LTS Ubuntu (Lucid Lynx).
 
 @warning{Apart from installing and configuring LilyDev in VirtualBox,
-the rest of the chapter on assumes that you are comfortable using the
+the rest of the chapter assumes that you are comfortable using the
 command-line.  While this chapter is intended for users who may have
 never created a patch or compiled software before, experienced
 developers (who prefer to use their own development environment) may
 command-line.  While this chapter is intended for users who may have
 never created a patch or compiled software before, experienced
 developers (who prefer to use their own development environment) may
@@ -93,7 +87,7 @@ Download Virtualbox from here:
 @end example
 
 @warning{In virtualization terminology, the operating system where
 @end example
 
 @warning{In virtualization terminology, the operating system where
-Virtualbox is installed, is the known as the @strong{host}.  LilyDev
+Virtualbox is installed is known as the @strong{host}.  LilyDev
 will be installed @q{inside} Virtualbox as a @strong{guest}.}
 
 @item
 will be installed @q{inside} Virtualbox as a @strong{guest}.}
 
 @item
@@ -282,7 +276,7 @@ the software directly. See @ref{Manually installing lily-git.tcl}.
 
 @item
 Finally, lily-git is always part of the LilyPond source code and is
 
 @item
 Finally, lily-git is always part of the LilyPond source code and is
-located in @file{~/lilypond-git/scripts/auxillar/lily-git.tcl}.
+located in @file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}.
 
 @end itemize
 
 
 @end itemize
 
@@ -311,7 +305,7 @@ lily-git with this information.
 @item
 Click on the @qq{Get source} button.
 
 @item
 Click on the @qq{Get source} button.
 
-A directory called @file{lilypond-git/} is now created within
+A directory called @file{$LILYPOND_GIT} is now created within
 your home directory and the complete source code will start to be
 downloaded into it.
 
 your home directory and the complete source code will start to be
 downloaded into it.
 
@@ -328,7 +322,7 @@ minutes -- it could be an intermittant network problem.  If the
 problem persists, please ask for help.}
 
 @item
 problem persists, please ask for help.}
 
 @item
-Close the lily-git GUI and navigate to the @file{lilypond-git/}
+Close the lily-git GUI and navigate to the @file{$LILYPOND_GIT}
 directory to view and edit the source files.
 
 @end enumerate
 directory to view and edit the source files.
 
 @end enumerate
@@ -344,7 +338,7 @@ to @ref{Compiling with LilyDev} before reading on.
 @warning{Throughout the rest of this manual, most command-line
 input should be entered from @file{~/lilypond-git/}.  This is
 known as the @emph{top source directory} and is often referred to as
 @warning{Throughout the rest of this manual, most command-line
 input should be entered from @file{~/lilypond-git/}.  This is
 known as the @emph{top source directory} and is often referred to as
-@var{$LILYPOND_GIT}}.
+@var{$LILYPOND_GIT}.}
 
 @warning{Only work on one set of changes at once.  Do not start
 work on any new changes until your first set has been accepted.}
 
 @warning{Only work on one set of changes at once.  Do not start
 work on any new changes until your first set has been accepted.}
@@ -421,11 +415,6 @@ Send patch files to the appropriate place:
 @item
 If you have a mentor, send it to them via email.
 
 @item
 If you have a mentor, send it to them via email.
 
-@item
-New contributors should send the patch attached to an email to
-@email{frogs@@lilynet.net}.  Please add @qq{[PATCH]} to the
-subject line.
-
 @item
 Translators should send patches to
 @email{translations@@lilynet.net}.
 @item
 Translators should send patches to
 @email{translations@@lilynet.net}.
@@ -435,6 +424,10 @@ More experienced contributors should upload the patch for
 web-based review.  This requires additional software and use of
 the command-line; see @ref{Uploading a patch for review}.
 
 web-based review.  This requires additional software and use of
 the command-line; see @ref{Uploading a patch for review}.
 
+@item
+If you have trouble uploading the patch for review,
+ask for help on @email{lilypond-devel@@gnu.org}.
+
 @end itemize
 
 
 @end itemize
 
 
@@ -444,7 +437,7 @@ the command-line; see @ref{Uploading a patch for review}.
 hopelessly confused!}
 
 The button labeled @qq{Abort changes -- Reset to origin} will copy
 hopelessly confused!}
 
 The button labeled @qq{Abort changes -- Reset to origin} will copy
-all changed files to a subdirectory of @file{lilypond-git/} named
+all changed files to a subdirectory of @file{$LILYPOND_GIT} named
 @file{aborted_edits/}, and will reset the repository to the
 current state of the remote repository (at @code{git.sv.gnu.org}).
 
 @file{aborted_edits/}, and will reset the repository to the
 current state of the remote repository (at @code{git.sv.gnu.org}).
 
@@ -465,7 +458,7 @@ text.  This should take less than a minute.
 @c we heavily recommend the out-of-tree build; do not change this!
 
 @example
 @c we heavily recommend the out-of-tree build; do not change this!
 
 @example
-cd ~/lilypond-git/
+cd $LILYPOND_GIT
 sh autogen.sh --noconfigure
 mkdir -p build/
 cd build/
 sh autogen.sh --noconfigure
 mkdir -p build/
 cd build/
@@ -481,14 +474,14 @@ building; this can have a non-negligible effect on compilation
 speed.
 
 @example
 speed.
 
 @example
-cd ~/lilypond-git/build/
+cd $LILYPOND_GIT/build/
 make
 @end example
 
 You may run the compiled @code{lilypond} with:
 
 @example
 make
 @end example
 
 You may run the compiled @code{lilypond} with:
 
 @example
-cd ~/lilypond-git/build/
+cd $LILYPOND_GIT/build/
 out/bin/lilypond my-file.ly
 @end example
 
 out/bin/lilypond my-file.ly
 @end example
 
@@ -498,7 +491,7 @@ Compiling the documentation is a much more involved process, and
 will likely take 2 to 10 hours.
 
 @example
 will likely take 2 to 10 hours.
 
 @example
-cd ~/lilypond-git/build/
+cd $LILYPOND_GIT/build/
 make
 make doc
 @end example
 make
 make doc
 @end example
@@ -508,14 +501,14 @@ view the html files by entering the below text; we recommend that
 you bookmark the resulting page:
 
 @example
 you bookmark the resulting page:
 
 @example
-firefox ~/lilypond-git/build/out-www/offline-root/index.html
+firefox $LILYPOND_GIT/build/out-www/offline-root/index.html
 @end example
 
 @subsubheading Installing
 
 Don't.  There is no reason to install lilypond within LilyDev.
 All development work can (and should) stay within the
 @end example
 
 @subsubheading Installing
 
 Don't.  There is no reason to install lilypond within LilyDev.
 All development work can (and should) stay within the
-@file{$HOME/lilypond-git/} directory, and any personal composition
+@file{$LILYPOND_GIT} directory, and any personal composition
 or typesetting work should be done with an official GUB release.
 
 
 or typesetting work should be done with an official GUB release.