Documentation/topdocs/README.yo

   1 COMMENT(-*-Text-*-)
   2
   3
   4 redef(XXsetchapternum)(0)()
   5
   6 notableofcontents()
   7 article(This is the toplevel README to LilyPond)()()
   8
   9 includefile(../BLURB.in)
  10
  11 sect(VERSIONING)
  12
  13 LilyPond uses a versioning scheme similar to the Linux kernel.  In a
  14 version "x.y.z", an even second number 'y' denotes a stable version.
  15 For development versions 'y' is odd.  For using straightforward score
  16 production, please use the latest stable version.  Development versions
  17 may not produce good or nice scores.
  18
  19 sect(REQUIREMENTS)
  20
  21 For the compilation and running of LilyPond you need some additional
  22 packages.  Please refer to the installation instructions.
  23
  24 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then
  25 you don't have to compile LilyPond.
  26
  27
  28 sect(INSTALLATION)
  29
  30 For your convenience, a formatted copy of the INSTALL instructions are
  31 in the toplevel directory, as INSTALL.txt
  32
  33 The process is fairly straightforward, but chances are that you have
  34 to specify directories for TeX() to code(configure): this is done with
  35 the options code(--enable-tex-dir) and code(--enable-mf-dir)
  36
  37
  38 sect(DOCUMENTATION)
  39
  40 The real documentation is the directory Documentation/
  41
  42 To generate the pretty-printed docs, you have to run code(configure) first,
  43 and then do this:
  44
  45         make doc
  46
  47 You can also simply read the file(.yo) sources.  They are ASCII text.
  48 The complete documentation is accessible in formatted form at the
  49 website lurl(http://www.cs.uu.nl/people/hanwen/lilypond/index.html)
  50
  51
  52 sect(COMMENTS)
  53
  54 LilyPond is a long way from finished and polished.  We do appreciate
  55 criticism, comments, bugreports, patches, etc.
  56 verb(
  57            Please send your e-mail to one of the MAILING LISTS
  58 )
  59 and em(not) to us personally.  See file(Documentation/links.yo) for more info.
  60
  61
  62 sect(WINDOWS 32)
  63
  64 If you have received this file as part of a DOS/Window32 distribution
  65 (LilyPond-*.zip), then it is advisable to also download the source
  66 package, since it might contain more documentation
  67 lurl(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/)
  68
  69 If you decide to build LilyPond from source, please read the INSTALL.txt
  70 document first, especially the Windows NT/95 section.
  71
  72
  73 sect(CAVEATS)
  74
  75 * Please read the file BUGS for some ugly bugs.
  76
  77 * If you have installed a previous version, be sure to remove old font
  78 files, eg
  79 verb(rm `find /var/lib/texmf/fonts -name 'feta*'`)
  80
  81 a script to do this for you is in file(buildscripts/clean-fonts.sh)
  82
  83
  84 sect(CDROM DISTRIBUTIONS)
  85
  86 If you have received LilyPond on a cdrom, chances are that development
  87 has moved a some patchlevels up.  Please check the latest version of
  88 LilyPond before reporting bugs.
  89