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 If you want to read the documentation online, these are options:
  43 itemize(
  44 it() use file(.html). Refer to INSTALL.txt for info on how to make the
  45 .html documentation.
  46 it() use file(.html). Point your browser to
  47 lurl(http://www.cs.uu.nl/~hanwen/lilypond/index.html).
  48 it() use file(.dvi),  for the tutorial and reference manual. Do verb(
  49   make -C Documentation/tex/ dvi)
  50
  51 it() use ASCII. Do
  52 using verb(
  53         make -C Documentation/
  54 )
  55 The tutorial and the reference manual  can not be made in ASCII, as
  56 they contain graphics.
  57 )
  58
  59
  60
  61 sect(COMMENTS)
  62
  63 LilyPond is a long way from finished and polished.  We do appreciate
  64 criticism, comments, bugreports, patches, etc.
  65 verb(
  66            Please send your e-mail to one of the MAILING LISTS
  67 )
  68 and em(not) to us personally.  See file(Documentation/links.yo) for more info.
  69
  70
  71 sect(WINDOWS 32)
  72
  73 If you have received this file as part of a DOS/Window32 distribution
  74 (LilyPond-*.zip), then it is advisable to also download the source
  75 package, since it might contain more documentation
  76 lurl(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/)
  77
  78 If you decide to build LilyPond from source, please read the INSTALL.txt
  79 document first, especially the Windows NT/95 section.
  80
  81
  82 sect(CAVEATS)
  83
  84 * Please read the file BUGS for some ugly bugs.
  85
  86 * If you have installed a previous version, be sure to remove old font
  87 files, eg
  88 verb(rm `find /var/lib/texmf/fonts -name 'feta*'`)
  89
  90 a script to do this for you is in file(buildscripts/clean-fonts.sh)
  91
  92
  93 sect(BUGS)
  94
  95 Send bug reports to bug-gnu-music@gnu.org.  For help and questions use
  96 help-gnu-music@gnu.org and gnu-music-discuss@gnu.org.  Please consult
  97 the faq before mailing your problems.
  98
  99
 100 sect(CDROM DISTRIBUTIONS)
 101
 102 If you have received LilyPond on a cdrom, chances are that development
 103 has moved a some patchlevels up.  Please check the latest version of
 104 LilyPond before reporting bugs.
 105