Left: | ||
Right: |
OLD | NEW |
---|---|
1 @c -*- coding: utf-8; mode: texinfo; -*- | 1 @c -*- coding: utf-8; mode: texinfo; -*- |
2 | 2 |
3 @node Quick start | 3 @node Quick start |
4 @chapter Quick start | 4 @chapter Quick start |
5 | 5 |
6 Want to submit a patch for LilyPond? Great! Never created a patch | 6 Want to submit a patch for LilyPond? Great! Never created a patch |
7 before? Never compiled software before? No problem! This chapter is | 7 before? Never compiled software before? No problem! This chapter is |
8 for you and will help you do this as quickly and easily as possible. | 8 for you and will help you do this as quickly and easily as possible. |
9 | 9 |
10 @menu | 10 @menu |
11 * LilyDev:: | 11 * LilyDev:: |
12 * lily-git:: | 12 * lily-git:: |
13 * Compiling with LilyDev:: | 13 * Compiling with LilyDev:: |
14 * Now start work!:: | 14 * Now start work!:: |
15 @end menu | 15 @end menu |
16 | 16 |
17 @node LilyDev | 17 @node LilyDev |
18 @section LilyDev | 18 @section LilyDev |
19 | 19 |
20 There is a disk image of a @q{remix} of Ubuntu GNU/Linux available for | 20 There is a disk image of a @q{remix} of Debian GNU/Linux available for |
21 download which includes all the necessary software and tools to compile | 21 download which includes all the necessary software and tools to compile |
22 both LilyPond and the documentation. Called the | 22 both LilyPond and the documentation. Called the |
23 @qq{Ubuntu LilyPond Developer Remix}, but known simply as @qq{LilyDev} | 23 @qq{Debian LilyPond Developer Remix}, but known simply as @qq{LilyDev} |
24 for short. Although it is not possible to compile LilyPond on Windows | 24 for short. Although it is not possible to compile LilyPond on Windows |
25 and extremely difficult on MacOS, LilyDev can be installed and run | 25 and extremely difficult on MacOS, LilyDev can be installed and run |
26 inside a @q{virtual machine} on any of these operating systems without | 26 inside a @q{virtual machine} on any of these operating systems without |
27 disturbing your main operating system. The LilyDev disk image can also | 27 disturbing your main operating system. The LilyDev disk image can also |
28 be burnt to a DVD and installed like any other Ubuntu GNU/Linux | 28 be burnt to a DVD or copied into a USB stick and installed like any |
pkx166h
2014/09/23 07:58:03
.. or copied to a USB ... (I don't know why, but c
| |
29 distribution. | 29 other GNU/Linux distribution. |
30 | 30 |
31 Most virtualization software can be used but we recommend VirtualBox as | 31 Most virtualization software can be used but we recommend VirtualBox as |
32 it is available for all major operating systems and is easy to install | 32 it is available for all major operating systems and is easy to install |
33 & configure. | 33 & configure. |
34 | 34 |
35 If you are not familiar with GNU/Linux, it may be beneficial to read a | 35 If you are not familiar with GNU/Linux, it may be beneficial to read a |
36 couple of @qq{introduction to Ubuntu} web pages. | 36 couple of @qq{introduction to Linux} web pages. |
37 | 37 |
38 For those interested, the LilyDev remix is currently based on a 32bit | 38 For those interested, the LilyDev remix is currently based on a 32bit |
39 version of 10.04 LTS Ubuntu (Lucid Lynx). | 39 version of Debian 7 (Wheezy). The image is generated using Debian |
40 @uref{http://live.debian.net/, live-build} and the configuration | |
41 files are hosted on GitHub: | |
42 | |
43 @smallexample | |
44 @uref{https://github.com/fedelibre/LilyDev} | |
45 @end smallexample | |
40 | 46 |
41 @warning{Apart from installing and configuring LilyDev in VirtualBox, | 47 @warning{Apart from installing and configuring LilyDev in VirtualBox, |
42 the rest of the chapter assumes that you are comfortable using the | 48 the rest of the chapter assumes that you are comfortable using the |
43 command-line. While this chapter is intended for users who may have | 49 command-line. While this chapter is intended for users who may have |
44 never created a patch or compiled software before, experienced | 50 never created a patch or compiled software before, experienced |
45 developers (who prefer to use their own development environment) may | 51 developers (who prefer to use their own development environment) may |
46 still find it instructive to skim over this section.} | 52 still find it instructive to skim over this section.} |
47 | 53 |
48 @menu | 54 @menu |
49 * Where to get LilyDev:: | 55 * Where to get LilyDev:: |
50 * Installing LilyDev in VirtualBox:: | 56 * Installing LilyDev in VirtualBox:: |
51 * Configuring LilyDev in VirtualBox:: | 57 * Configuring LilyDev in VirtualBox:: |
52 @end menu | 58 @end menu |
53 | 59 |
54 | 60 |
55 @node Where to get LilyDev | 61 @node Where to get LilyDev |
56 @unnumberedsubsec Where to get LilyDev | 62 @unnumberedsubsec Where to get LilyDev |
57 | 63 |
58 Download the Ubuntu LilyPond Developer Remix CD image file | 64 Download the LilyDev image file (approximately 850 MB) from here: |
59 (approximately 1 GB) from here: | |
60 | 65 |
61 @smallexample | 66 @smallexample |
62 @uref{http://www.philholmes.net/lilypond/LilyDev/ubuntu-LilyDev-remix-2.6.iso} | 67 @uref{http://www.et.byu.edu/~sorensen/lilydev-3.0.iso} |
63 @end smallexample | 68 @end smallexample |
64 | 69 |
65 Some advanced users might want this file too: | 70 Some advanced users might want this file too: |
66 @smallexample | 71 @smallexample |
67 @uref{http://www.philholmes.net/lilypond/LilyDev/ubuntu-LilyDev-remix-2.6.iso.md 5} | 72 @uref{http://www.et.byu.edu/~sorensen/lilydev-3.0.iso.md5} |
68 @end smallexample | 73 @end smallexample |
69 (If you don't recognize what this file is, then you don't need it.) | 74 (If you don't recognize what this file is, then you don't need it.) |
70 | 75 |
71 An alternate site for obtaining these files is available: | |
72 @smallexample | |
73 @uref{http://www.et.byu.edu/~sorensen/ubuntu-LilyDev-remix-2.6.iso} | |
74 @uref{http://www.et.byu.edu/~sorensen/ubuntu-LilyDev-remix-2.6.iso.md5} | |
75 @end smallexample | |
76 | 76 |
77 | 77 |
78 @node Installing LilyDev in VirtualBox | 78 @node Installing LilyDev in VirtualBox |
79 @unnumberedsubsec Installing LilyDev in VirtualBox | 79 @unnumberedsubsec Installing LilyDev in VirtualBox |
80 | 80 |
81 This section discusses how to install and use LilyDev with VirtualBox. | 81 This section discusses how to install and use LilyDev with VirtualBox. |
82 | 82 |
83 @warning{If you already know how to install a virtual machine using a | 83 @warning{If you already know how to install a virtual machine using a |
84 disc image inside VirtualBox (or your own virtualization software) then | 84 disc image inside VirtualBox (or your own virtualization software) then |
85 you can skip this section and go straight to @ref{lily-git}.} | 85 you can skip this section and go straight to @ref{lily-git}.} |
(...skipping 10 matching lines...) Expand all Loading... | |
96 Virtualbox is installed is known as the @strong{host}. LilyDev | 96 Virtualbox is installed is known as the @strong{host}. LilyDev |
97 will be installed @q{inside} Virtualbox as a @strong{guest}.} | 97 will be installed @q{inside} Virtualbox as a @strong{guest}.} |
98 | 98 |
99 @item | 99 @item |
100 Start the VirtualBox software and click @q{New} to create a new | 100 Start the VirtualBox software and click @q{New} to create a new |
101 @qq{virtual machine}. | 101 @qq{virtual machine}. |
102 | 102 |
103 The @q{New Virtual Machine Wizard} will walk you through setting up your | 103 The @q{New Virtual Machine Wizard} will walk you through setting up your |
104 guest virtual machine. Choose an appropriate name for your LilyDev | 104 guest virtual machine. Choose an appropriate name for your LilyDev |
105 installation and select the @q{Linux} operating system. When selecting | 105 installation and select the @q{Linux} operating system. When selecting |
106 the @q{version} use @q{Ubuntu} if available (but not the @q{64 bit} | 106 the @q{version} choose @q{Debian (32 bit)} (don't use the @q{64 bit} |
107 option). If you do not have that specific option choose @q{Linux 2.6} | 107 option). If you do not have that specific option choose @q{Linux 2.6} |
108 (again do not choose any option that has 64 bit next to it). | 108 (again do not choose any option that has 64 bit next to it). |
109 | 109 |
110 @item | 110 @item |
111 Select the amount of RAM you will allow the LilyDev guest to use from | 111 Select the amount of RAM you will allow the LilyDev guest to use from |
112 your host operating system when it is running. If possible, use at | 112 your host operating system when it is running. If possible, use at |
113 least 700 MB of RAM; the more RAM you can spare from your host the | 113 least 700 MB of RAM; the more RAM you can spare from your host the |
114 better, although LilyDev will currently use no more than 4 GB (4096 MB) | 114 better, although LilyDev will currently use no more than 4 GB (4096 MB) |
115 even if you are able to assign more. | 115 even if you are able to assign more. |
116 | 116 |
117 @item | 117 @item |
118 For your @q{Virtual Hard Disk}, leave the @q{Create new hard disk} | 118 For your @q{Virtual Hard Disk}, leave the @q{Create new hard disk} |
119 option checked, use the default @q{VDI} and | 119 option checked, use the default @q{VDI} and |
120 @qq{Dynamically allocated} options for the virtual hard drive. A | 120 @qq{Dynamically allocated} options for the virtual hard drive. A |
121 complete compile of everything (code, docs, regression tests) can reach | 121 complete compile of everything (code, docs, regression tests) can reach |
122 10 GB so size your virtual disk and its location accordingly. | 122 10 GB so size your virtual disk and its location accordingly. |
123 | 123 |
124 @item | 124 @item |
125 Verify the summary details and click @q{Create}, when you are satisfied. | 125 Verify the summary details and click @q{Create}, when you are satisfied. |
126 Your new guest will be displayed in the Virtualbox window. Click the | 126 Your new guest will be displayed in the Virtualbox window. |
127 @q{Start} button and the @q{First Run Wizard} will prompt you for | 127 @warning{The image contains a 686-pae kernel, so you must enable PAE |
128 in the virtual machine settings: clic on @clicksequence{System @click{} Processo r} | |
pkx166h
2014/09/23 07:58:02
'click' not 'clic'.
Also I try not to break lines
fedelogy
2014/09/23 23:20:53
it is already on one line
mislead by html fluid li
| |
129 and select @q{Extended features: Enable PAE/NX}.} | |
130 | |
131 @item | |
132 Click the @q{Start} button and the @q{First Run Wizard} will prompt you for | |
128 the installation media. Click the browse icon and locate the LilyDev | 133 the installation media. Click the browse icon and locate the LilyDev |
129 disk image and click through the wizard to start the installation | 134 disk image and click through the wizard to start the installation |
130 process. | 135 process. |
131 | 136 |
132 @item | 137 @item |
133 When the LilyDev disk image boots, it shows a prompt: | 138 When the LilyDev disk image boots, you should choose the @q{Install} or |
134 | 139 the @q{Graphical install} menu item to begin the installation of |
135 @example | 140 LilyDev on your virtual hard disk. The installer will walk you |
136 ISOLINUX @code{boot:} | |
137 @end example | |
138 | |
139 Hit the Return key (or wait 30 seconds) and then when the installer | |
140 screen loads, using the arrow keys select | |
141 @q{Install - start the installer directly} to begin the install process | |
142 of LilyDev on your virtual hard disk. The Ubuntu software will walk you | |
143 through the complete installation process. | 141 through the complete installation process. |
144 | 142 |
143 @warning{We suggest leaving the root password blank, so your user | |
144 will be automatically granted root privileges and you'll have to | |
145 remember just one password.} | |
pkx166h
2014/09/23 07:58:02
@warning{If the root password is left blank when p
fedelogy
2014/09/23 23:20:53
Acknowledged.
| |
146 | |
145 @item | 147 @item |
146 At the @qq{Prepare disk space} stage, do not be afraid to select | 148 At the @qq{Partition disks} stage, do not be afraid to select |
147 @qq{Erase and use the entire disk}, since this refers to your | 149 @qq{Guided - use entire disk}, since this refers to your |
148 @strong{@emph{virtual disk}}, not your machine's actual hard | 150 @strong{@emph{virtual disk}}, not your machine's actual hard |
149 disk. | 151 disk. |
150 | 152 |
151 @item | 153 @item |
152 Click through the rest of the wizard, filling in any appropriate details | 154 Click through the rest of the wizard, filling in any appropriate details |
153 when asked and wait for the install to complete. | 155 when asked and wait for the install to complete. |
154 | 156 This will take about 10 minutes in a recent computer. |
pkx166h
2014/09/23 07:58:03
'..recent computer' is wrong. But I think we could
fedelogy
2014/09/23 23:20:53
Done.
| |
155 @warning{This will take anywhere from 10 minutes to up to an hour | |
156 depending on the speed of your computer and if Ubuntu detects you are | |
157 connected to the internet and needs to download any additional | |
158 security updates or patches, although these updates are not required to | |
159 compile LilyPond and it is possible to skip the additional downloads to | |
160 speed up the install process.} | |
161 | 157 |
162 @item | 158 @item |
163 When prompted by the Ubuntu installer wizard, restart the virtual | 159 When the installation is completed, just click on Continue (you |
pkx166h
2014/09/23 07:58:03
'When the installation is complete, ...' or '..has
fedelogy
2014/09/23 23:20:53
Done.
| |
164 machine and then when prompted to @q{eject the CD} by virtual box, just | 160 don't have to remove any media since you installed from a file |
165 click inside the virtual machine window and hit the return key to | 161 on your host filesystem). The installer will reboot the virtual |
166 reboot the virtual machine. It will not try to restart the installer | 162 machine: LilyDev is now installed and running! |
167 but start the virtual machine proper. LilyDev is now installed and | |
168 running! | |
169 | |
170 @item | |
171 The current version of LilyPond requires the texlive-lang-cyrillic | |
172 package. This package is not part of LilyDev 2.6. Add the package | |
173 to LilyDev with: | |
174 | |
175 @example | |
176 sudo apt-get install texlive-lang-cyrillic | |
177 @end example | |
178 | 163 |
179 | 164 |
180 @end enumerate | 165 @end enumerate |
181 | 166 |
182 @knownissues | 167 @knownissues |
183 Not all hardware is supported in all virtualization tools. In | 168 Not all hardware is supported in all virtualization tools. In |
184 particular, some contributors have reported problems with USB network | 169 particular, some contributors have reported problems with USB network |
185 adapters. If you have problems with network connection (for example | 170 adapters. If you have problems with network connection (for example |
186 Internet connection in the host system is lost when you launch virtual | 171 Internet connection in the host system is lost when you launch virtual |
187 system), try installing and running LilyDev with your computer's | 172 system), try installing and running LilyDev with your computer's |
(...skipping 14 matching lines...) Expand all Loading... | |
202 @enumerate | 187 @enumerate |
203 | 188 |
204 @item | 189 @item |
205 Select the @q{Devices} menu from the virtual machine window and choose | 190 Select the @q{Devices} menu from the virtual machine window and choose |
206 @q{Install Guest Additions...}. This will automount a CD which will | 191 @q{Install Guest Additions...}. This will automount a CD which will |
207 prompt you to autorun it. Click OK and follow the instructions. It is | 192 prompt you to autorun it. Click OK and follow the instructions. It is |
208 recommended to reboot the guest when the installation is complete. | 193 recommended to reboot the guest when the installation is complete. |
209 | 194 |
210 Other virtualization software will also have their own @q{guest} | 195 Other virtualization software will also have their own @q{guest} |
211 additions, follow the normal procedures for your virtualization software | 196 additions, follow the normal procedures for your virtualization software |
212 with Ubuntu as the client. | 197 with LilyDev as the client. |
213 | 198 |
214 @item | 199 @item |
215 Restart Ubuntu to complete the installation of the guest additions. | 200 Restart LilyDev to complete the installation of the guest additions. |
216 | 201 |
217 @advanced{If you do any kernel upgrades, you may need to reinstall | 202 @advanced{If you do any kernel upgrades, you may need to reinstall |
218 the additional software. Just follow the step above again and reboot | 203 the additional software. Just follow the step above again and reboot |
219 when the reinstallation is complete.} | 204 when the reinstallation is complete.} |
220 | 205 |
221 @end enumerate | 206 @end enumerate |
222 | 207 |
223 @noindent | 208 @noindent |
224 Other items that may be helpful: | 209 Other items that may be helpful: |
225 | 210 |
226 @itemize | 211 @itemize |
227 | 212 |
228 @item | 213 @item |
229 In the settings for the virtual machine, set the network to | 214 In the settings for the virtual machine, set the network to |
230 Bridged mode to allow you to access shared folders when using Windows | 215 Bridged mode to allow you to access shared folders when using Windows |
231 hosts. | 216 hosts. |
232 | 217 |
233 @item | 218 @item |
234 Set up any additional features, such as @q{Shared Folders} between | 219 Set up any additional features, such as @q{Shared Folders} between |
235 your main operating system and Ubuntu. This is distinct from the | 220 your main operating system and LilyDev. This is distinct from the |
236 networked share folders in Windows. Consult the external | 221 networked share folders in Windows. Consult the external |
237 documentation for this. | 222 documentation for this. |
238 | 223 |
239 Some longtime contributors have reported that @q{shared folders} | 224 Some longtime contributors have reported that @q{shared folders} |
240 are rarely useful and not worth the fuss, particularly since files | 225 are rarely useful and not worth the fuss, particularly since files |
241 can be shared over a network instead. | 226 can be shared over a network instead. |
242 | 227 |
243 @item | 228 @item |
244 Pasting into a terminal is done with @code{Ctrl+Shift+v}. | 229 Pasting into a terminal is done with @code{Ctrl+Shift+v}. |
245 | 230 |
246 @item | 231 @item |
247 The @qq{Places} top-menu has shortcuts to a graphical | 232 Right-click allows you to edit a file with the text editor (default |
248 @qq{navigator} like Windows Explorer or the MacOS X Finder. | 233 is Leafpad). |
249 | |
250 @item | |
251 Right-click allows you to edit a file with gedit. We recommend | |
252 using gedit. | |
253 | 234 |
254 @item | 235 @item |
255 One particular change from Windows and MacOS X is that most | 236 One particular change from Windows and MacOS X is that most |
256 software should be installed with your @qq{package manager}; this | 237 software should be installed with your @qq{package manager}; this |
257 vastly simplifies the process of installing and configuring | 238 vastly simplifies the process of installing and configuring |
258 software. Go to @clicksequence{Applications @click{} Ubuntu | 239 software. If you use LilyDev 3.0 and you need a graphical |
259 Software Center}. | 240 package manager type this command in a terminal: |
241 | |
242 @c synaptic will be added in the next version of LilyDev | |
243 | |
244 @example | |
245 sudo apt-get install synaptic | |
246 @end example | |
247 | |
248 Go to the menu at the bottom left and click on | |
249 @clicksequence{Preferences @click{} Synaptic Package Manager}. | |
260 | 250 |
261 @end itemize | 251 @end itemize |
262 | 252 |
263 | 253 |
264 @node lily-git | 254 @node lily-git |
265 @section lily-git | 255 @section lily-git |
266 | 256 |
267 The @q{LilyPond Contributor's Git Interface} (otherwise known as | 257 The @q{LilyPond Contributor's Git Interface} (otherwise known as |
268 @command{lily-git.tcl}) is a simple-to-use GUI to help you download and | 258 @command{lily-git.tcl}) is a simple-to-use GUI to help you download and |
269 update the LilyPond source code as well as an aid to making software | 259 update the LilyPond source code as well as an aid to making software |
270 patches. | 260 patches. |
271 | 261 |
272 @menu | 262 @menu |
273 * Where to get lily-git:: | 263 * Where to get lily-git:: |
274 * Configuring lily-git and downloading the source code:: | 264 * Configuring lily-git and downloading the source code:: |
275 * How to use lily-git:: | 265 * How to use lily-git:: |
276 @end menu | 266 @end menu |
277 | 267 |
278 @node Where to get lily-git | 268 @node Where to get lily-git |
279 @unnumberedsubsec Where to get lily-git | 269 @unnumberedsubsec Where to get lily-git |
280 | 270 |
281 Depending on your development environment, lily-git may already be | 271 Depending on your development environment, lily-git may already be |
282 installed on your computer. | 272 installed on your computer. |
283 | 273 |
284 @itemize | 274 @itemize |
285 @item | 275 @item |
286 If you are using LilyDev (see @ref{LilyDev}) then lily-git is already | 276 If you are using LilyDev (see @ref{LilyDev}) then lily-git should be |
287 installed and ready to run. | 277 already installed and ready to run. This is not the case for the |
278 current version (3.0), but you can easily turn it on by adding this | |
279 line in ~/.bashrc: | |
280 | |
281 @example | |
282 # add lily-git to the PATH | |
283 PATH=$LILYPOND_GIT/scripts/auxiliar:"$@{PATH@}" | |
284 @end example | |
288 | 285 |
289 @item | 286 @item |
290 For those not using LilyDev then lily-git can be obtained by downloading | 287 For those not using LilyDev then lily-git can be obtained by downloading |
291 the software directly. See @ref{Manually installing lily-git.tcl}. | 288 the software directly. See @ref{Manually installing lily-git.tcl}. |
292 | 289 |
293 @item | 290 @item |
294 Finally, lily-git is always part of the LilyPond source code and is | 291 Finally, lily-git is always part of the LilyPond source code and is |
295 located in @file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}. | 292 located in @file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}. |
296 | 293 |
297 @end itemize | 294 @end itemize |
(...skipping 157 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
455 The button labeled @qq{Abort changes -- Reset to origin} will copy | 452 The button labeled @qq{Abort changes -- Reset to origin} will copy |
456 all changed files to a subdirectory of @file{$LILYPOND_GIT} named | 453 all changed files to a subdirectory of @file{$LILYPOND_GIT} named |
457 @file{aborted_edits/}, and will reset the repository to the | 454 @file{aborted_edits/}, and will reset the repository to the |
458 current state of the remote repository (at @code{git.sv.gnu.org}). | 455 current state of the remote repository (at @code{git.sv.gnu.org}). |
459 | 456 |
460 | 457 |
461 | 458 |
462 @node Compiling with LilyDev | 459 @node Compiling with LilyDev |
463 @section Compiling with LilyDev | 460 @section Compiling with LilyDev |
464 | 461 |
465 LilyDev is our @q{remix} of Ubuntu which contains all the | 462 LilyDev is our @q{remix} of Debian which contains all the |
466 necessary dependencies to do lilypond development; for more | 463 necessary dependencies to do lilypond development; for more |
467 information, see @rcontrib{LilyDev}. | 464 information, see @ref{LilyDev}. |
468 | 465 |
469 @subsubheading Preparing the build | 466 @subsubheading Preparing the build |
470 | 467 |
471 To prepare the build directory, enter (or copy&paste) the below | 468 To prepare the build directory, enter (or copy&paste) the below |
472 text. This should take less than a minute. | 469 text. This should take less than a minute. |
473 | 470 |
474 @c we heavily recommend the out-of-tree build; do not change this! | 471 @c we heavily recommend the out-of-tree build; do not change this! |
475 | 472 |
476 @example | 473 @example |
477 cd $LILYPOND_GIT | 474 cd $LILYPOND_GIT |
(...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
559 these at your leisure, a few weeks after beginning work with | 556 these at your leisure, a few weeks after beginning work with |
560 LilyDev. | 557 LilyDev. |
561 | 558 |
562 @itemize | 559 @itemize |
563 @item @ref{Working with source code} | 560 @item @ref{Working with source code} |
564 @item @ref{Compiling} | 561 @item @ref{Compiling} |
565 @end itemize | 562 @end itemize |
566 | 563 |
567 | 564 |
568 | 565 |
OLD | NEW |