@node Quick start
@chapter Quick start
-Want to submit a patch for LilyPond? Great! This chapter is
-designed to let you do this as quickly and easily as possible.
-
-It is not possible to compile LilyPond on Windows, and extremely
-difficulty to compile it on MacOS X. We have therefore made a
-@q{remix} of Ubuntu which includes all necessary dependencies to
-compile both LilyPond and the documentation. This can be run
-inside a virtual machine without disturbing your main operating
-system.
-
-@advanced{experienced developers may prefer to use their own
-development environment. It may be instructive to skim over these
-instructions, but be aware that this chapter is intended for
-helpful users who may have never created a patch before.}
+Want to submit a patch for LilyPond? Great! Never created a patch
+before? Never compiled software before? No problem! This chapter is
+for you and will help you do this as quickly and easily as possible.
@menu
-* Lilybuntu::
-* Using lily-git::
-* Compiling with lilybuntu::
+* LilyDev::
+* lily-git::
+* Compiling with LilyDev::
* Now start work!::
@end menu
-@node Lilybuntu
-@section Lilybuntu
-
-text.
+@node LilyDev
+@section LilyDev
+
+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{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 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 Linux} web pages.
+
+For those interested, the LilyDev remix is currently based on a 32bit
+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
+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.}
@menu
-* Installing lilybuntu::
-* Configuring lilybuntu in virtualbox::
-* Using lilybuntu::
+* Where to get LilyDev::
+* Installing LilyDev in VirtualBox::
+* Configuring LilyDev in VirtualBox::
@end menu
-@node Installing lilybuntu
-@subsection Installing lilybuntu
-@enumerate
-@item
-Install some virtualization software.
+@node Where to get LilyDev
+@unnumberedsubsec Where to get LilyDev
+
+Download the LilyDev image file (approximately 850 MB) from here:
+
+@smallexample
+@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.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.)
-Any virtualization tool can be used, but we recommend VirtualBox:
-@example
-@uref{http://@/www.virtualbox.org/@/wiki/@/Downloads}
-@end example
-In virtualization terminology, your main operating system is the
-@qq{host}, while lilybuntu is the @qq{guest}.
+@node Installing LilyDev in VirtualBox
+@unnumberedsubsec Installing LilyDev in VirtualBox
+This section discusses how to install and use LilyDev with VirtualBox.
+
+@warning{If you already know how to install a virtual machine using a
+disc image inside VirtualBox (or your own virtualization software) then
+you can skip this section and go straight to @ref{lily-git}.}
+
+@enumerate
@item
-Download the @file{lilybuntu2.iso} disk image: (approximately 1
-GB)
+Download Virtualbox from here:
@example
-@uref{http://files.lilynet.net/lilybuntu2.iso}
+@uref{http://@/www.virtualbox.org/@/wiki/@/Downloads}
@end example
-@advanced{There is a md5sum available:
-@uref{http://files.lilynet.net/lilybuntu2.iso.md5}}
+@warning{In virtualization terminology, the operating system where
+Virtualbox is installed is known as the @strong{host}. LilyDev
+will be installed @q{inside} Virtualbox as a @strong{guest}.}
@item
-Install @file{lilybuntu2.iso} as the @qq{guest} operating system
-on your virtualized system.
+Start the VirtualBox software and click @q{New} to create a new
+@qq{virtual machine}.
-@itemize
+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} 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).
@item
-If possible, use at least 700 MB of RAM (1GB would be better) for
-the virtual machine, and use @qq{dynamically expanding storage}
-for the virtual hard drive. A complete compile of everything
-(code, docs, regression tests) can reach 10 GB.
+Select the amount of RAM you will allow the LilyDev guest to use from
+your host operating system when it is running. If possible, use at
+least 700 MB of RAM; the more RAM you can spare from your host the
+better, although LilyDev will currently use no more than 4 GB (4096 MB)
+even if you are able to assign more.
@item
-When @file{lilybuntu2.iso} boots, it shows an ISOLINUX
-@code{boot:} prompt. Type:
-
-@example
-install
-@end example
+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.
@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
-@emph{virtual disk}, not your machine's actual hard drive.
+Verify the summary details and click @q{Create}, when you are satisfied.
+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
-When prompted to remove the installation CD, go to
-@clicksequence{Devices @click{} CD/DVD Devices} and de-select
-@file{lilybuntu2.iso}.
+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.
-@end itemize
+@item
+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.
-@advanced{
-The latest version of lilybuntu is based on Ubuntu 10.04.1; if you
-encounter any difficulties installing it, search for one of the
-many tutorials for installing that particular version of Ubuntu as
-a guest operating system.
-}
+@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
-Do any extra configuration for your virtualization software.
+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.
-There are additional instructions for VirtualBox in
-@ref{Configuring lilybuntu in virtualbox}.
+@item
+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 in a recent computer.
-If you use other virtualization software, then follow the normal
-procedures for your virtualization software with Ubuntu as the
-client.
+@item
+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!
-@advanced{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 help for your virtualization tool using your normal OS as
-the @qq{host} and Ubuntu as the @qq{client}.}
@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.
+
-@node Configuring lilybuntu in virtualbox
-@subsection Configuring lilybuntu in virtualbox
+@node Configuring LilyDev in VirtualBox
+@unnumberedsubsec Configuring LilyDev in VirtualBox
-VirtualBox has extra @qq{guest additions} which can make the
-virtualization easier to use (full-screen, easy file sharing
-between host and guest operating systems, shared clipboards, etc).
+VirtualBox has extra @q{guest additions} which although are not
+necessary to use LilyDev or compile Lilypond, do provide some additional
+features to your Virtual Machine to make it easier to work with. Such
+as being able to dynamically resize the LilyDev window, allow seamless
+interaction with your mouse pointer on both the host and guest and let
+you copy/paste between your host and guest if needed.
@enumerate
@item
-In @emph{VirtualBox}, select @clicksequence{Devices @click{}
-Install Guest Additions...}.
+Select the @q{Devices} menu from the virtual machine window and choose
+@q{Install Guest Additions...}. This will automount a CD which will
+prompt you to autorun it. Click OK and follow the instructions. It is
+recommended to reboot the guest when the installation is complete.
-@item
-In @emph{Ubuntu}, select @clicksequence{Places @click{}
-VBOXADDITIONS_}. A file-system window will open.
+Other virtualization software will also have their own @q{guest}
+additions, follow the normal procedures for your virtualization software
+with LilyDev as the client.
@item
-Double-click on the @file{autorun.sh} file, then select @qq{Run in
-Terminal}, and enter your password when prompted.
+Restart LilyDev to complete the installation of the guest additions.
-@item
-Once the script is finished, restart Ubuntu to complete the
-installation.
+@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 re-run
-these VBOXADDITIONS instructions.}
@end enumerate
-Some other steps may be helpful:
+@noindent
+Other items that may be helpful:
@itemize
+
@item
In the settings for the virtual machine, set the network to
-Bridged mode to allow you to access shared folders on your Windows
-host.
+Bridged mode to allow you to access shared folders when using Windows
+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 external
-documentation for this step.
+your main operating system and LilyDev. This is distinct from the
+networked share folders in Windows. Consult the external
+documentation for this.
-TODO: maybe we should just nuke this point? is it easier to do
-networked file sharing in osx, linux, etc, thus making the
-virtualbox "shared folders" not useful?
+Some longtime contributors have reported that @q{shared folders}
+are rarely useful and not worth the fuss, particularly since files
+can be shared over a network instead.
-@end itemize
-
-
-@node Using lilybuntu
-@subsection Using lilybuntu
+@item
+Pasting into a terminal is done with @code{Ctrl+Shift+v}.
-If you are not familiar with Linux, it may be beneficial to read a
-couple of @qq{introduction to Ubuntu} webpages.
+@item
+Right-click allows you to edit a file with the text editor (default
+is Leafpad).
-@itemize
@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}.
-
-@item
-The rest of this manual assumes that you are using the
-command-line; go to @clicksequence{Applications @click{}
-Accessories @click{} Terminal}.
+software. If you use LilyDev 3.0 and you need a graphical
+package manager type this command in a terminal:
-@item
-Pasting into a terminal is done with @code{Ctrl+Shift+v}.
-
-@item
-Some contributors have recommended: (pdf available for free)
+@c synaptic will be added in the next version of LilyDev
@example
-@uref{http://www.ubuntupocketguide.com/}
+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
-@c if you change this node name, you'll need to change the @ref in
-@c web/ and/or included/, along with all the translations.
-@node Using lily-git
-@section Using lily-git
+@node lily-git
+@section lily-git
-@command{lily-git.tcl} is a graphical tool to help you access and
-share changes to the lilypond source code.
+The @q{LilyPond Contributor's Git Interface} (otherwise known as
+@command{lily-git.tcl}) is a simple-to-use GUI to help you download and
+update the LilyPond source code as well as an aid to making software
+patches.
@menu
-* Install and configuration of lily-git.tcl::
-* Daily use of lily-git.tcl::
+* Where to get lily-git::
+* Configuring lily-git and downloading the source code::
+* How to use lily-git::
@end menu
-@node Install and configuration of lily-git.tcl
-@unnumberedsubsec Install and configuration of @command{lily-git.tcl}
+@node Where to get lily-git
+@unnumberedsubsec Where to get lily-git
-@warning{The rest of this manual assumes that you are using the
-command-line; go to @clicksequence{Applications @click{}
-Accessories @click{} Terminal}.}
+Depending on your development environment, lily-git may already be
+installed on your computer.
-@enumerate
+@itemize
@item
-@code{lily-git.tcl} has already been installed for you. Simply type
-(or copy&paste):
+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
-cd
-wish lily-git.tcl
+# add lily-git to the PATH
+PATH=$LILYPOND_GIT/scripts/auxiliar:"$@{PATH@}"
@end example
@item
-Click on the @qq{Get source} button.
-
-This will create a directory called @file{lilypond-git/} within
-your home directory, and will download the source code into that
-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}.
+For those not using LilyDev then lily-git can be obtained by downloading
+the software directly. See @ref{Manually installing lily-git.tcl}.
@item
-Navigate to the @file{lilypond-git/} directory to view the source
-files.
+Finally, lily-git is always part of the LilyPond source code and is
+located in @file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}.
-@end enumerate
+@end itemize
-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}.}
+@node Configuring lily-git and downloading the source code
+@unnumberedsubsec Configuring lily-git and downloading the source code
-
-@subsubheading Other operating systems
+@warning{The rest of this manual assumes that you are using the
+command-line within a terminal.}
@enumerate
@item
-If you haven't already, download and install Git.
-
-@itemize
-
-@item
-Lilybuntu users: git has already been installed for you.
-
-@item Windows users: download the @code{.exe} file labeled
-@qq{Full installer for official Git} from:
+Type (or copy&paste) into the Terminal:
@example
-@uref{http://code.google.com/p/msysgit/downloads/list}
+lily-git.tcl
@end example
-@item Other operating systems: either install @command{git} with
-your package manager, or download it from the @qq{Binaries}
-section of:
-
-@example
-@uref{http://git-scm.com/download}
-@end example
-
-@end itemize
-
+@noindent
+You will be prompted to enter your name and your email address. This
+information is used only to identify and label any patches you create.
+This information can be edited if required later. See
+@ref{Configuring Git}. Click on the @emph{Submit} button to update
+lily-git with this information.
@item
-Download the @command{lily-git.tcl} script from:
+Click on the @qq{Get source} button.
-@c don't change the cgit link below to gitweb; gitweb uses
-@c long filenames like "scripts_auxiliar_lily-git.tcl"
+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.
-@example
-@uref{http://git.sv.gnu.org/cgit/lilypond.git/plain/scripts/auxiliar/lily-git.tcl}
-@end example
+@warning{Be patient! The complete source is around 150@tie{}Mb.}
-@item
-To run the program from the command line, navigate to the
-directory containing @command{lily-git.tcl} and enter:
+@noindent
+When the source code has been downloaded, the @qq{Command output} window
+in lily-git will update and display @qq{Done} on the very last line.
+The button label will change to say @qq{Update source}.
-@example
-wish lily-git.tcl
-@end example
+@warning{Some contributors have reported that occasionally nothing
+happens at this step at all. If this occurs, then try again in a few
+minutes -- it could be an intermittant network problem. If the
+problem persists, please ask for help.}
@item
-Go read the lilybuntu instructions, starting from the @qq{get
-source} step.
+Close the lily-git GUI and navigate to the @file{$LILYPOND_GIT}
+directory to view and edit the source files.
@end enumerate
-@advanced{the @qq{Get source} button does not fetch the entire
-history of the git repository, so utilities like @command{gitk}
-will only be able to display the most recent additions. As you
-continue to work with @command{lily-git.tcl}, the @qq{Update
-source} button will take any new additions and add it to whatever
-is currently in your repository's history.}
+@noindent
+If this is the first time you have compiled LilyPond then please go
+to @ref{Compiling with LilyDev} before reading on.
-@node Daily use of lily-git.tcl
-@unnumberedsubsec Daily use of @command{lily-git.tcl}
+@node How to use lily-git
+@unnumberedsubsec How to use lily-git
+
+@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}.}
@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.}
@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}.
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
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}).
-@node Compiling with lilybuntu
-@section Compiling with lilybuntu
+@node Compiling with LilyDev
+@section Compiling with LilyDev
-Lilybuntu 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{Lilybuntu}.
+information, see @ref{LilyDev}.
@subsubheading Preparing the build
To prepare the build directory, enter (or copy&paste) the below
text. This should take less than a minute.
+@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/
../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,
+Compiling lilypond will likely take between 5 and 60 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/
+cd $LILYPOND_GIT/build/
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
will likely take 2 to 10 hours.
@example
-cd ~/lilypond-git/build/
+cd $LILYPOND_GIT/build/
+make
make doc
@end 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 Other options
+@subsubheading Installing
+
+Don't. There is no reason to install lilypond within LilyDev.
+All development work can (and should) stay within the
+@file{$LILYPOND_GIT} directory, and any personal composition
+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 the rest of
-this chapter.
+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!
-Lilybuntu users may now skip to the chapter which is aimed at
+LilyDev 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}
+@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
projects / lilypond.git / blobdiff