3.7 Repository directory structure
Prebuilt Documentation and packages are available from:
http://www.lilypond.org
LilyPond development is hosted at:
http://savannah.gnu.org/projects/lilypond
Here is a simple explanation of the directory layout for
LilyPond's source files.
. Toplevel READMEs, files for
| configuration and building, etc.
|
|-- Documentation/ Top sources for most of the manuals
| |
| |
| | INDIVIDUAL CHAPTERS FOR EACH MANUAL:
| | Note: "Snippets" and "Internals Reference" are
| | auto-generated during the Documentation Build process.
| |
| |
| |-- en/contributor/ Contributor's Guide
| |-- en/essay/ Essay on automated music engraving
| |-- en/extending/ Extending the functionality of LilyPond
| |-- en/included/ Doc files that are used more than once
| |-- en/learning/ Learning Manual
| |-- en/notation/ Notation Reference
| |-- en/usage/ How to run the programs that come with LilyPond
| |-- en/web/ Website files
| |
| |
| | TRANSLATED MANUALS:
| | Each language's directory can contain...
| | 1) translated versions of:
| | * "en/*" sources for manuals
| | * individual chapters for each manual
| | 2) a texidocs/ directory for snippet translations
| |
| |-- ca/ Catalan
| |-- cs/ Czech
| |-- de/ German
| |-- es/ Spanish
| |-- fr/ French
| |-- hu/ Hungarian
| |-- it/ Italian
| |-- ja/ Japanese
| |-- nl/ Dutch
| |-- pt/ Portuguese
| |-- zh/ Chinese
| |
| |
| | MISCELLANEOUS DOC STUFF:
| |
| |-- bib/ Bibliography files for documentation
| |-- css/ CSS files for HTML docs
| |-- logo/ Web logo and "note" icon
| |-- ly-examples/ .ly files for the "Examples" webpage
| |-- misc/ Old announcements, ChangeLogs and NEWS
| |-- pictures/ Images used (eps/jpg/png/svg)
| | `-- pdf/ (pdf)
| |-- po/ Translated build/maintenance scripts
| |-- snippets/ Auto-generated from the LSR and from ./new/
| | `-- new/ Snippets too new for the LSR
| |-- topdocs/ AUTHORS, INSTALL
| `-- tex/ TeX and texinfo library files
|
|
| C++ SOURCES:
|
|-- flower/ A simple C++ library
| `-- include/ C++ header files for basic LilyPond structures
|-- lily/ C++ sources for the LilyPond binary
| `-- include/ C++ header files for higher-level stuff
|
|
| LIBRARIES:
|
|-- ly/ .ly \include files
|-- mf/ MetaFont sources for Emmentaler fonts
|-- ps/ PostScript library files
|-- scm/ Scheme sources for LilyPond and subroutine files
|
|
| SCRIPTS:
|
|-- config/ Autoconf helpers for configure script
|-- python/ Python modules, MIDI module
| `-- auxiliar/ Python modules for build/maintenance
|-- scripts/ End-user scripts (--> lilypond/usr/bin/)
| |-- auxiliar/ Maintenance and non-essential build scripts
| `-- build/ Essential build scripts
|
|
| BUILD PROCESS:
| (also see SCRIPTS section above)
|
|-- make/ Specific make subroutine files
|
|
| REGRESSION TESTS:
|
|-- input/
| `-- regression/ .ly regression tests
| |-- abc2ly/ .abc regression tests
| |-- lilypond-book/
| | lilypond-book regression tests
| |-- midi/ midi2ly regression tests
| |-- musicxml/ .xml and .itexi regression tests
| `-- other/ regression tests without graphical output
|
|
| MISCELLANEOUS:
|
|-- elisp/ Emacs LilyPond mode and syntax coloring
|-- vim/ Vi(M) LilyPond mode and syntax coloring
|-- po/ Translations for binaries and end-user scripts
`-- docker/
`-- ci/ Support for continuous integration (CI) on gitlab