X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fcontributor%2Fquick-start.itexi;h=6d6dec3e7c87538a2b9960288d6751b4b63c91f2;hb=01bf90e7c2819dbca42ab514239f4b35d6721ddc;hp=2484b8e31aaac020cecc0b3c58422fc10a68e230;hpb=5cd6aa0b3fed6fae7f965dbcc38fc16cc9e0a74b;p=lilypond.git diff --git a/Documentation/contributor/quick-start.itexi b/Documentation/contributor/quick-start.itexi index 2484b8e31a..6d6dec3e7c 100644 --- a/Documentation/contributor/quick-start.itexi +++ b/Documentation/contributor/quick-start.itexi @@ -17,62 +17,52 @@ 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 -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} -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. - -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. +@c This text was written based on LilyDev 4.0 - JL -If you are not familiar with GNU/Linux, it may be beneficial to read a -couple of @qq{introduction to Ubuntu} web pages. +There is a @q{remix} of Debian GNU/Linux -- known as @qq{LilyDev} for +short -- which includes all the necessary software and tools to compile +LilyPond, the documentation and the website (also see +@ref{Website work}). -For those interested, the LilyDev remix is currently based on a 32bit -version of 10.04 LTS Ubuntu (Lucid Lynx). +@warning{LilyDev does not include the software for the Grand Unified +Builder -- also see @ref{Grand Unified Builder (GUB)}.} -@warning{Apart from installing and configuring LilyDev in VirtualBox, -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 -still find it instructive to skim over this section.} +While compiling LilyPond on MacOs and Windows is possible, both +environments are complex to set up. LilyDev can be easily installed +and run inside a @q{virtual machine} on either of these operating +systems relatively easily using readily available virtualization +software. We recommend using VirtualBox as it is available for all +major operating systems and is very easy to install & configure. -@menu -* Where to get LilyDev:: -* Installing LilyDev in VirtualBox:: -* Configuring LilyDev in VirtualBox:: -@end menu +The LilyDev disk image can also be written to a USB device or @q{burnt} +to a DVD -- it is approximately 900 GB in size -- and installed just +like any standard GNU/Linux distribution. +The current image is based on a 32bit version of Debian 8 (@q{Jessie}) +and the Disk image was generated using Debian +@uref{http://live.debian.net/, live-build 4}. -@node Where to get LilyDev -@unnumberedsubsec Where to get LilyDev +@noindent +Download the LilyDev disk image file from here: -Download the Ubuntu LilyPond Developer Remix CD image file -(approximately 1 GB) from here: +@example +@uref{https://github.com/fedelibre/LilyDev/releases/latest} +@end example -@smallexample -@uref{http://www.philholmes.net/lilypond/LilyDev/ubuntu-LilyDev-remix-2.6.iso} -@end smallexample +@warning{Apart from installing and configuring LilyDev in VirtualBox, +the rest of the chapter assumes that you are comfortable using the +command-line and is intended for users who may have never created a +patch or compiled software before. More experienced developers (who +prefer to use their own development environment) may still find it +instructive to skim over the following information.} -Some advanced users might want this file too: -@smallexample -@uref{http://www.philholmes.net/lilypond/LilyDev/ubuntu-LilyDev-remix-2.6.iso.md5} -@end smallexample -(If you don't recognize what this file is, then you don't need it.) +If you are not familiar with GNU/Linux, it may be beneficial to read a +a few @qq{introduction to Linux} type web pages. -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 +@menu +* Installing LilyDev in VirtualBox:: +* Configuring LilyDev in VirtualBox:: +@end menu @node Installing LilyDev in VirtualBox @@ -89,7 +79,7 @@ you can skip this section and go straight to @ref{lily-git}.} Download Virtualbox from here: @example -@uref{http://@/www.virtualbox.org/@/wiki/@/Downloads} +@uref{http://www.virtualbox.org/wiki/Downloads} @end example @warning{In virtualization terminology, the operating system where @@ -103,7 +93,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). @@ -116,77 +106,51 @@ even if you are able to assign more. @item For your @q{Virtual Hard Disk}, leave the @q{Create new hard disk} -option checked, use the default @q{VDI} and -@qq{Dynamically allocated} options for the virtual hard drive. A -complete compile of everything (code, docs, regression tests) can reach -10 GB so size your virtual disk and its location accordingly. +option checked, use the default @q{VDI} and @qq{Dynamically allocated} +options for the virtual hard drive. A complete compile of everything +(code, docs, regression tests) can reach 10 GB so size your virtual disk +and its location accordingly. @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 -the installation media. Click the browse icon and locate the LilyDev -disk image and click through the wizard to start the installation -process. +Your new guest will be displayed in the Virtualbox window. -@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 -through the complete installation process. +@warning{The image contains a @q{686-pae} kernel, so you must enable +@code{PAE} within the virtual machine's settings -- click on +@clicksequence{System @click{} Processor} and select +@q{Extended features: Enable PAE/NX}.} @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 -@strong{@emph{virtual disk}}, not your machine's actual hard -disk. +Click the @q{Start} button and the @q{First Run Wizard} will prompt you +for the installation media. Click the browse icon, locate the LilyDev +disk image and click through the wizard to begin the installation +process. @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.} +When the LilyDev disk image boots for the first time, choose either the +@q{Install} or the @q{Graphical install} menu item. The installer will +then walk you through the complete installation 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! +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 computer's own hard disk. @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 +Continue to click through the rest of the wizard, filling in any +appropriate details when asked, and wait for the install to complete. +This will take about 10 minutes or so on a reasonably modern computer. +@item +When the installation is completed, just click on @q{Continue} (you +do not have to remove any media since you installed LilyDev from a Disk +image, which is just a file on your computer). The installer will +reboot the virtual machine. @end enumerate -@knownissues -Not all hardware is supported in all virtualization tools. In -particular, some contributors have reported problems with 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. Refer to the -help documentation that comes with your virtualization software. +@noindent +LilyDev should now be installed and running! @node Configuring LilyDev in VirtualBox @@ -209,14 +173,14 @@ 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 -when the reinstallation is complete.} +@advanced{If you do any kernel upgrades, you may need to reinstall the +additional software. Just follow the step above again and reboot when +the reinstallation is complete.} @end enumerate @@ -232,9 +196,9 @@ hosts. @item Set up any additional features, such as @q{Shared Folders} between -your main operating system and Ubuntu. This is distinct from the -networked share folders in Windows. Consult the external -documentation for this. +your main operating system and LilyDev. This is distinct from the +networked share folders in Windows. Consult the external documentation +for this. Some longtime contributors have reported that @q{shared folders} are rarely useful and not worth the fuss, particularly since files @@ -244,22 +208,20 @@ 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. - -@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}. +Right-click allows you to edit a file with the text editor (default +is Leafpad). @end itemize +@knownissues +Not all hardware is supported in all virtualization tools. In +particular, some contributors have reported problems with 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. Refer to the +help documentation that comes with your virtualization software. + @node lily-git @section lily-git @@ -283,8 +245,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 +431,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