]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/contributor/quick-start.itexi
CG: add new instructions for LilyDev 3 (issue 2538)
[lilypond.git] / Documentation / contributor / quick-start.itexi
index 2484b8e31aaac020cecc0b3c58422fc10a68e230..ce6fa2b0f96444b09d42e4afc67005cfb8e9bd07 100644 (file)
@@ -17,26 +17,32 @@ for you and will help you do this as quickly and easily as possible.
 @node LilyDev
 @section LilyDev
 
-There is a disk image of a @q{remix} of Ubuntu GNU/Linux available for
+There is a disk image of a @q{remix} of Debian 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}
+@qq{Debian LilyPond Developer Remix}, but known simply as @qq{LilyDev}
 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
-be burnt to a DVD and installed like any other Ubuntu GNU/Linux
-distribution.
+be burnt to a DVD or copied to a USB stick and installed like any
+other 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.
 
 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 Linux} web pages.
 
 For those interested, the LilyDev remix is currently based on a 32bit
-version of 10.04 LTS Ubuntu (Lucid Lynx).
+version of Debian 7 (Wheezy).  The image is generated using Debian
+@uref{http://live.debian.net/, live-build} and the configuration
+files are hosted on GitHub:
+
+@smallexample
+@uref{https://github.com/fedelibre/LilyDev}
+@end smallexample
 
 @warning{Apart from installing and configuring LilyDev in VirtualBox,
 the rest of the chapter assumes that you are comfortable using the
@@ -55,24 +61,18 @@ still find it instructive to skim over this section.}
 @node Where to get LilyDev
 @unnumberedsubsec Where to get LilyDev
 
-Download the Ubuntu LilyPond Developer Remix CD image file
-(approximately 1 GB) from here:
+Download the LilyDev image file (approximately 850 MB) from here:
 
 @smallexample
-@uref{http://www.philholmes.net/lilypond/LilyDev/ubuntu-LilyDev-remix-2.6.iso}
+@uref{http://www.et.byu.edu/~sorensen/lilydev-3.0.iso}
 @end smallexample
 
 Some advanced users might want this file too:
 @smallexample
-@uref{http://www.philholmes.net/lilypond/LilyDev/ubuntu-LilyDev-remix-2.6.iso.md5}
+@uref{http://www.et.byu.edu/~sorensen/lilydev-3.0.iso.md5}
 @end smallexample
 (If you don't recognize what this file is, then you don't need it.)
 
-An alternate site for obtaining these files is available:
-@smallexample
-@uref{http://www.et.byu.edu/~sorensen/ubuntu-LilyDev-remix-2.6.iso}
-@uref{http://www.et.byu.edu/~sorensen/ubuntu-LilyDev-remix-2.6.iso.md5}
-@end smallexample
 
 
 @node Installing LilyDev in VirtualBox
@@ -103,7 +103,7 @@ Start the VirtualBox software and click @q{New} to create a new
 The @q{New Virtual Machine Wizard} will walk you through setting up your
 guest virtual machine.  Choose an appropriate name for your LilyDev
 installation and select the @q{Linux} operating system.  When selecting
-the @q{version} use @q{Ubuntu} if available (but not the @q{64 bit}
+the @q{version} choose @q{Debian (32 bit)} (don't use the @q{64 bit}
 option).  If you do not have that specific option choose @q{Linux 2.6}
 (again do not choose any option that has 64 bit next to it).
 
@@ -123,58 +123,43 @@ complete compile of everything (code, docs, regression tests) can reach
 
 @item
 Verify the summary details and click @q{Create}, when you are satisfied.
-Your new guest will be displayed in the Virtualbox window.  Click the
-@q{Start} button and the @q{First Run Wizard} will prompt you for
+Your new guest will be displayed in the Virtualbox window.
+@warning{The image contains a 686-pae kernel, so you must enable PAE
+in the virtual machine settings: click on @clicksequence{System @click{} Processor}
+and select @q{Extended features: Enable PAE/NX}.}
+
+@item
+Click the @q{Start} button and the @q{First Run Wizard} will prompt you for
 the installation media.  Click the browse icon and locate the LilyDev
 disk image and click through the wizard to start the installation
 process.
 
 @item
-When the LilyDev disk image boots, it shows a prompt:
-
-@example
-ISOLINUX @code{boot:}
-@end example
-
-Hit the Return key (or wait 30 seconds) and then when the installer
-screen loads, using the arrow keys select
-@q{Install - start the installer directly} to begin the install process
-of LilyDev on your virtual hard disk.  The Ubuntu software will walk you
+When the LilyDev disk image boots, you should choose the @q{Install} or
+the @q{Graphical install} menu item to begin the installation of
+LilyDev on your virtual hard disk.  The installer will walk you
 through the complete installation process.
 
+@warning{If the root password is left blank when prompted, the configured user
+account will be be given root privileges automatically.  This means that only
+one password needs to be remembered.}
+
 @item
-At the @qq{Prepare disk space} stage, do not be afraid to select
-@qq{Erase and use the entire disk}, since this refers to your
+At the @qq{Partition disks} stage, do not be afraid to select
+@qq{Guided - use entire disk}, since this refers to your
 @strong{@emph{virtual disk}}, not your machine's actual hard
 disk.
 
 @item
 Click through the rest of the wizard, filling in any appropriate details
 when asked and wait for the install to complete.
-
-@warning{This will take anywhere from 10 minutes to up to an hour
-depending on the speed of your computer and if Ubuntu detects you are
-connected to the internet and needs to download any additional
-security updates or patches, although these updates are not required to
-compile LilyPond and it is possible to skip the additional downloads to
-speed up the install process.}
-
-@item
-When prompted by the Ubuntu installer wizard, restart the virtual
-machine and then when prompted to @q{eject the CD} by virtual box, just
-click inside the virtual machine window and hit the return key to
-reboot the virtual machine.  It will not try to restart the installer
-but start the virtual machine proper. LilyDev is now installed and
-running!
+This will take about 10 minutes in a recent computer.
 
 @item
-The current version of LilyPond requires the texlive-lang-cyrillic
-package.  This package is not part of LilyDev 2.6.  Add the package
-to LilyDev with:
-
-@example
-sudo apt-get install texlive-lang-cyrillic
-@end example
+When the installation is completed, just click on Continue (you
+don't have to remove any media since you installed from a file
+on your host filesystem).  The installer will reboot the virtual
+machine: LilyDev is now installed and running!
 
 
 @end enumerate
@@ -209,10 +194,10 @@ recommended to reboot the guest when the installation is complete.
 
 Other virtualization software will also have their own @q{guest}
 additions, follow the normal procedures for your virtualization software
-with Ubuntu as the client.
+with LilyDev as the client.
 
 @item
-Restart Ubuntu to complete the installation of the guest additions.
+Restart LilyDev to complete the installation of the guest additions.
 
 @advanced{If you do any kernel upgrades, you may need to reinstall
 the additional software.  Just follow the step above again and reboot
@@ -232,7 +217,7 @@ hosts.
 
 @item
 Set up any additional features, such as @q{Shared Folders} between
-your main operating system and Ubuntu.  This is distinct from the
+your main operating system and LilyDev.  This is distinct from the
 networked share folders in Windows.  Consult the external
 documentation for this.
 
@@ -244,19 +229,24 @@ can be shared over a network instead.
 Pasting into a terminal is done with @code{Ctrl+Shift+v}.
 
 @item
-The @qq{Places} top-menu has shortcuts to a graphical
-@qq{navigator} like Windows Explorer or the MacOS X Finder.
-
-@item
-Right-click allows you to edit a file with gedit.  We recommend
-using gedit.
+Right-click allows you to edit a file with the text editor (default
+is Leafpad).
 
 @item
 One particular change from Windows and MacOS X is that most
 software should be installed with your @qq{package manager}; this
 vastly simplifies the process of installing and configuring
-software.  Go to @clicksequence{Applications @click{} Ubuntu
-Software Center}.
+software.  If you use LilyDev 3.0 and you need a graphical
+package manager type this command in a terminal:
+
+@c synaptic will be added in the next version of LilyDev
+
+@example
+sudo apt-get install synaptic
+@end example
+
+Go to the menu at the bottom left and click on
+@clicksequence{Preferences @click{} Synaptic Package Manager}.
 
 @end itemize
 
@@ -283,8 +273,15 @@ installed on your computer.
 
 @itemize
 @item
-If you are using LilyDev (see @ref{LilyDev}) then lily-git is already
-installed and ready to run.
+If you are using LilyDev (see @ref{LilyDev}) then lily-git should be
+already installed and ready to run.  This is not the case for the
+current version (3.0), but you can easily turn it on by adding this
+line in ~/.bashrc:
+
+@example
+# add lily-git to the PATH
+PATH=$LILYPOND_GIT/scripts/auxiliar:"$@{PATH@}"
+@end example
 
 @item
 For those not using LilyDev then lily-git can be obtained by downloading
@@ -462,9 +459,9 @@ current state of the remote repository (at @code{git.sv.gnu.org}).
 @node Compiling with LilyDev
 @section Compiling with LilyDev
 
-LilyDev is our @q{remix} of Ubuntu which contains all the
+LilyDev is our @q{remix} of Debian which contains all the
 necessary dependencies to do lilypond development; for more
-information, see @rcontrib{LilyDev}.
+information, see @ref{LilyDev}.
 
 @subsubheading Preparing the build