Documentation/topdocs/README.yo

   1 COMMENT(-*-Text-*-)
   2 DEFINEMACRO(Package)(0)(LilyPond) DEFINEMACRO(package)(0)(lilypond)
   3 COMMENT(    ^^^^     Slaat dit ergens op?)
   4
   5
   6 redef(XXsetchapternum)(0)()
   7
   8 This is the toplevel README to Package()
   9
  10 includefile(../BLURB.in)
  11
  12 sect(VERSIONING)
  13
  14 if you have downloaded a
  15
  16         *.pre*
  17
  18 version, then this is version is *not* meant for producing nice output
  19 (but to keep your patchsets up to date).  It might not even compile.
  20 The same goes for a version with a 4th version number, eg
  21
  22         1.2.3.mypatch2
  23
  24 It will be safer if you download 1.2.3 or wait for 1.2.4.
  25
  26
  27
  28 sect(REQUIREMENTS)
  29
  30 For the compilation and running of Package() you need some additional
  31 packages.  Please refer to the installation instructions.
  32
  33 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then
  34 you don't have to compile Package().
  35
  36
  37 sect(INSTALLATION)
  38
  39 For your convenience, a formatted copy of the INSTALL instructions are
  40 in the toplevel directory, as INSTALL.txt
  41
  42 The process is fairly straightforward, but chances are that you have
  43 to specify directories for TeX() to code(configure): this is done with
  44 the options code(--enable-tex-dir) and code(--enable-mf-dir)
  45
  46
  47 sect(DOCUMENTATION)
  48
  49 The real documentation is the directory Documentation/
  50
  51 To generate the pretty-printed docs, you have to run code(configure) first,
  52 and then do this:
  53
  54         make doc
  55
  56 You can also simply read the .yo sources.  They are ASCII text.
  57 The complete documentation is accessible in formatted form at the
  58 website lurl(http://www.cs.uu.nl/people/hanwen/lilypond/index.html)
  59
  60
  61 sect(COMMENTS)
  62
  63 Package() is a long way from finished and polished.  We do appreciate
  64 criticism, comments, bugreports, patches, etc.
  65
  66            Please send your e-mail to one of the MAILING LISTS
  67
  68 and 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 (package()-*.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 Package() 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.  This especially applies
  85 Linux-Intel unix users.
  86
  87 * If you have installed a previous version, be sure to remove old font
  88 files, eg
  89 verb(rm `find /var/lib/texmf/fonts -name 'feta*'`)
  90
  91 a script to do this for you is in file(bin/cleanfonts.sh)
  92
  93
  94 sect(CDROM DISTRIBUTIONS)
  95
  96 If you have received Package() on a cdrom, chances are that development
  97 has moved a some patchlevels up.  If possible, please check the latest
  98 version of Package() before reporting bugs.
  99