X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fcontributor%2Fquick-start.itexi;h=9a5b12a7ec36d597e6eef5875588c2d65ec6c4d5;hb=306c0929457ca5dd92a8f5edeb72515301e55c87;hp=de89c5edd189f7cae3a6eae2f124b5af6965f453;hpb=58aac84ce756a2ddc4468d6944f03dd46153de3f;p=lilypond.git diff --git a/Documentation/contributor/quick-start.itexi b/Documentation/contributor/quick-start.itexi index de89c5edd1..9a5b12a7ec 100644 --- a/Documentation/contributor/quick-start.itexi +++ b/Documentation/contributor/quick-start.itexi @@ -28,7 +28,7 @@ LilyPond, the documentation and the website (also see @warning{LilyDev does not include the software for the Grand Unified Builder -- also see @ref{Grand Unified Builder (GUB)}.} -While compiling LilyPond on MacOs and Windows is possible, both +While compiling LilyPond on Mac OS 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 @@ -39,12 +39,12 @@ The LilyDev disk image can also be written to a USB device or @q{burnt} to a DVD -- it is approximately 900 MB 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 +The current image is based on a 32-bit version of Debian 8 (@q{Jessie}) +and the disk image was generated using Debian @uref{http://live.debian.net/, live-build 4}. @noindent -Download the LilyDev disk image file from here: +Download the LilyDev disk image file (a @code{.iso} file) from here: @example @uref{https://github.com/fedelibre/LilyDev/releases/latest} @@ -124,8 +124,8 @@ Your new guest will be displayed in the VirtualBox window. @item 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. +disk image file that you downloaded (the @code{.iso} file) and click +through the wizard to begin the installation process. @item When the LilyDev disk image boots for the first time, choose either the @@ -295,7 +295,7 @@ directory and the entire source code will start to be downloaded into it. @warning{Be patient! There is no progress bar in the lily-git UI but the -complete source is around 180@tie{}Mb.} +complete source is around 180@tie{}MB.} @noindent When the source code has been downloaded, the @qq{command output} window @@ -489,10 +489,10 @@ PATH=~/directory_containing_git-cl:"$@{PATH@}" @node Updating git-cl @unnumberedsubsec Updating @code{git-cl} -LilyDev users should always make sure that they alwsys have the latest -version of git-cl installed. It is possible that changes may have been -made to git-cl that are not (yet) included in the version of LilyDev has -been installed. +LilyDev users should make sure that they always have the latest +version of git-cl installed. It is possible that changes have been +made to git-cl that are not (yet) included in the version of LilyDev +that you are using. @noindent Using a terminal run the following commands: @@ -510,21 +510,26 @@ This will download and update you to the lastest version of git-cl. @subsubheading Set up login accounts -Because the @code{git-cl} updates two separate websites (Google's -Rietveld Code Review Tool and LilyPond's issue tracker) you @emph{must} -have a valid user login and password to both sites. +Because @code{git-cl} updates two separate websites (Google's Rietveld +Code Review Tool and LilyPond's issue tracker) you @emph{must} have a +valid user account (login and password) for both sites. @noindent -Although that it may appear that you have to use a @q{Google} email -address for the Rietveld Code Review Tool when you sign up, you can -instead select the option @qq{I prefer to use my current email address} -during sign up. +For the Rietveld Code Review Tool you will need a Google account. Note +that a Google account does not require that you have or use a @q{Google} +email address. You can use @emph{any} email address for your Google +account. Just select the option @qq{I prefer to use my current email +address} when you sign up. + +@warning{In order for @code{git-cl} to work, your Google Account +Settings must have the @q{Access for less secure apps} set to +@q{Allowed}. This is normally the default setting.} @noindent -For a user login to the LilyPond issue tracker, please send your -request, preferably using the email address you want to use for your -login, to the LilyPond Developer's mailing list -(@code{lilypond-devel@@gnu.org}). +For the LilyPond issue tracker, please request a user account by sending +an email to the LilyPond Developer's mailing list +(@code{lilypond-devel@@gnu.org}), preferably using the same email +address that you want to use for your user login. @subsubheading Authorising git-cl for the LilyPond issue tracker @@ -533,8 +538,8 @@ it can access the LilyPond issue tracker. @enumerate @item -Once a valid login has been given for the LilyPond issye tracker, go to -the @q{Account settings} and select the @q{OAuth} tab. +Once you have been given a valid login for the LilyPond issue tracker, +go to the @q{Account settings} and select the @q{OAuth} tab. @item Locate the @q{Register New Application} section and enter @code{git-cl} @@ -545,7 +550,7 @@ Click on the @q{Register new application} button. You should now see @q{git-cl} listed under the @q{My Applications} section. @item -Click on the @q{Generate Bearer Token} button. You should now see +Click on the @q{Generate Bearer Token} button. You should now see @q{git-cl} listed under the @q{Authorized Applications} section along with a value for the @q{Bearer Token} entry. This value is used, in the next steps, to allow git-cl to access and update the LilyPond issue @@ -557,24 +562,30 @@ tracker. @enumerate @item -Using a terminal, move to top source directory of the -@code{$LILYPOND_GIT} directory and then run @code{git-cl} with the -@code{config} option: +Using a terminal, move to the top level of the @code{$LILYPOND_GIT} +directory and then run @code{git-cl} with the @code{config} option: @example cd $LILYPOND_GIT git-cl config @end example +@noindent +You will see a series of prompts. For most of them you can simply +accept the default value by responding with a newline (i.e. by pressing +return or enter). + @item -When prompted for the @code{Rietveld server}: +The prompt for the @code{Rietveld server} (the patch review tool), which +defaults to @code{codereview.appspot.com} @example Rietveld server (host[:port]) [codereview.appspot.com]: @end example @item -When prompted for the @code{Allura server} (the LilyPond issue tracker): +The prompt for the @code{Allura server} (the issue tracker), which +defaults to @code{https://sourceforge.net/p/testlilyissues/issues/} @example Allura server [https://sourceforge.net/p/testlilyissues/issues/]: @@ -583,18 +594,18 @@ Allura server [https://sourceforge.net/p/testlilyissues/issues/]: @item When prompted for the @code{Allura bearer token} copy/paste the value generated in the previous steps for -@emph{Authorising git-cl for the LilyPond issue tracker}: +@emph{Authorising git-cl for the LilyPond issue tracker} @smallexample -Allura bearer token (see https://sourceforge.net/auth/oauth/) [fdbfca60801533465480]: +Allura bearer token (see https://sourceforge.net/auth/oauth/): fdbfca60801533465480 @end smallexample -@warning{The above is a @q{fake} bearer token just to illustrate the -example. Do not use this value.} +@warning{The above is a @q{fake} bearer token used just for +illustration. Do not use this value.} @item -Finally, when prompted for the @code{CC list} entry, add the LilyPond -Developer's group email. +Finally, the prompt for the @code{CC list}, which defaults to +@code{lilypond-devel@@gnu.org}, the LilyPond Developer's email list. @example CC list ("x" to clear) [lilypond-devel@@gnu.org]: