ROADMAP

   1 Prebuilt Documentation and packages are available from:
   2
   3     http://www.lilypond.org
   4
   5 LilyPond development is hosted at:
   6
   7     https://gitlab.com/lilypond/
   8
   9 Here is a simple explanation of the directory layout for
  10 LilyPond's source files.
  11
  12
  13 .                        Toplevel READMEs, files for
  14 |                          configuration and building, etc.
  15 |
  16 |-- Documentation/       Top sources for most of the manuals
  17 |   |
  18 |   |
  19 |   |   INDIVIDUAL CHAPTERS FOR EACH MANUAL:
  20 |   |     Note: "Snippets" and "Internals Reference" are
  21 |   |     auto-generated during the Documentation Build process.
  22 |   |
  23 |   |
  24 |   |-- en/contributor/  Contributor's Guide
  25 |   |-- en/essay/        Essay on automated music engraving
  26 |   |-- en/extending/    Extending the functionality of LilyPond
  27 |   |-- en/included/     Doc files that are used more than once
  28 |   |-- en/learning/     Learning Manual
  29 |   |-- en/notation/     Notation Reference
  30 |   |-- en/usage/        How to run the programs that come with LilyPond
  31 |   |-- en/web/          Website files
  32 |   |
  33 |   |
  34 |   |   TRANSLATED MANUALS:
  35 |   |     Each language's directory can contain...
  36 |   |       1) translated versions of:
  37 |   |          * "en/*" sources for manuals
  38 |   |          * individual chapters for each manual
  39 |   |       2) a texidocs/ directory for snippet translations
  40 |   |
  41 |   |-- ca/              Catalan
  42 |   |-- de/              German
  43 |   |-- es/              Spanish
  44 |   |-- fr/              French
  45 |   |-- it/              Italian
  46 |   |-- ja/              Japanese
  47 |   |-- zh/              Chinese
  48 |   |
  49 |   |
  50 |   |   MISCELLANEOUS DOC STUFF:
  51 |   |
  52 |   |-- bib/             Bibliography files for documentation
  53 |   |-- css/             CSS files for HTML docs
  54 |   |-- logo/            Web logo and "note" icon
  55 |   |-- ly-examples/     .ly example files for the webpage
  56 |   |-- misc/            Old announcements, ChangeLogs and NEWS
  57 |   |-- pictures/        Images (eps/jpg/png/svg) for the webpage
  58 |   |   `-- pdf/         (pdf)
  59 |   |-- po/              Translated build/maintenance scripts
  60 |   |-- snippets/        Auto-generated from the LSR and from ./new/
  61 |   |   `-- new/         Snippets too new for the LSR
  62 |   |-- topdocs/         AUTHORS, INSTALL
  63 |   `-- tex/             TeX and texinfo library files
  64 |
  65 |
  66 |   C++ SOURCES:
  67 |
  68 |-- flower/              A simple C++ library
  69 |   `-- include/         C++ header files for basic LilyPond structures
  70 |-- lily/                C++ sources for the LilyPond binary
  71 |   `-- include/         C++ header files for higher-level stuff
  72 |
  73 |
  74 |   LIBRARIES:
  75 |
  76 |-- ly/                  .ly \include files
  77 |-- mf/                  MetaFont sources for Emmentaler fonts
  78 |-- ps/                  PostScript library files
  79 |-- scm/                 Scheme sources for LilyPond and subroutine files
  80 |
  81 |
  82 |   SCRIPTS:
  83 |
  84 |-- config/              Autoconf helpers for configure script
  85 |-- m4/                  Files used while generating the configure script
  86 |-- python/              Python modules, MIDI module
  87 |   `-- auxiliar/        Python modules for build/maintenance
  88 |-- scripts/             End-user scripts (--> lilypond/usr/bin/)
  89 |   |-- auxiliar/        Maintenance and non-essential build scripts
  90 |   `-- build/           Essential build scripts
  91 |
  92 |
  93 |   BUILD PROCESS:
  94 |   (also see SCRIPTS section above)
  95 |
  96 |-- make/                Specific make subroutine files
  97 |
  98 |-- docker/
  99 |   |-- base/            CI Docker files used for running `make`
 100 |   |-- ci/              Support for continuous integration (CI) on gitlab
 101 |   `-- doc/             CI Docker files used for running `make doc`
 102 |
 103 |-- release/             Scripts to generate and upload release packages
 104 |   |-- binaries/        Scripts to build binaries
 105 |   |   |-- ansible/     Ansible playbooks for building binaries
 106 |   |   |-- lib/         Auxiliary files for building binaries
 107 |   |   `-- relocate/    Relocation data for lilypond binary
 108 |   `-- doc              Scripts to build documentation
 109 |
 110 |   REGRESSION TESTS:
 111 |
 112 |-- input/
 113 |   `-- regression/      .ly regression tests
 114 |       |-- abc2ly/      .abc regression tests
 115 |       |-- lilypond-book/
 116 |       |                lilypond-book regression tests
 117 |       |-- midi/        midi2ly regression tests
 118 |       |-- musicxml/    .xml and .itexi regression tests
 119 |       `-- other/       regression tests without graphical output
 120 |
 121 |
 122 |   MISCELLANEOUS:
 123 |
 124 |-- elisp/               Emacs LilyPond mode and syntax coloring
 125 |-- vim/                 Vi(M) LilyPond mode and syntax coloring
 126 `-- po/                  Translations for binaries and end-user scripts