]> git.donarmstrong.com Git - lilypond.git/blob - ROADMAP
CG: Add note about `git stash'.
[lilypond.git] / ROADMAP
1 Prebuilt Documentation and packages are available from:
2
3     http://www.lilypond.org
4
5 LilyPond development is hosted at:
6
7     http://savannah.gnu.org/projects/lilypond
8
9 Here is a simple explanation of the directory layout for
10 LilyPond's source files.
11
12
13 .                        Toplevel READMEs, ChangeLog,
14 |                          build bootstrapping, patches
15 |                          for third party programs
16 |
17 |-- Documentation/       Top sources for manuals
18 |   |
19 |   |
20 |   |   INDIVIDUAL CHAPTERS FOR EACH MANUAL:
21 |   |
22 |   |-- contributor/     Contributor's Guide
23 |   |-- essay/           Essay on automated music engraving
24 |   |-- extending/       Extending
25 |   |-- learning/        Learning Manual
26 |   |-- notation/        Notation Reference
27 |   |-- usage/           Usage
28 |   |-- web/             The website
29 |   |   `-- ly-examples/ .ly files for the "Examples" page
30 |   |
31 |   |
32 |   |   TRANSLATED MANUALS:
33 |   |
34 |   |-- de/              German
35 |   |-- es/              Spanish
36 |   |-- fr/              French
37 |   |-- hu/              Hungarian
38 |   |-- it/              Italian
39 |   |-- ja/              Japanese
40 |   |-- nl/              Dutch
41 |   |
42 |   |
43 |   |   MISCELLANEOUS DOC STUFF:
44 |   |
45 |   |-- css/             CSS files for HTML docs
46 |   |-- included/        .ly files used in the manuals
47 |   |-- logo/            Web logo and "note" icon
48 |   |-- misc/            Old announcements, ChangeLogs and NEWS
49 |   |-- pictures/        Images used (eps/jpg/png/svg)
50 |   |   `-- pdf/         (pdf)
51 |   |-- po/              Translated build/maintenance scripts
52 |   |-- snippets/        Auto-generated .ly snippets (from the LSR)
53 |   |   `-- new/         Snippets too new for the LSR
54 |   `-- topdocs/         AUTHORS, INSTALL, README
55 |
56 |
57 |   C++ SOURCES:
58 |
59 |-- flower/              A simple C++ library
60 |-- lily/                C++ sources for the LilyPond binary
61 |
62 |
63 |   LIBRARIES:
64 |
65 |-- ly/                  .ly \include files
66 |-- mf/                  MetaFont sources for Emmentaler and Aybabtu fonts
67 |-- ps/                  PostScript library files
68 |-- scm/                 Scheme sources for LilyPond and subroutine files
69 |-- tex/                 TeX and texinfo library files
70 |
71 |
72 |   SCRIPTS:
73 |
74 |-- python/              Python modules, MIDI module
75 |   `-- auxiliar/        Python modules for build/maintenance
76 |-- scripts/             End-user scripts (--> lilypond/usr/bin/)
77 |   |-- auxiliar/        Maintenance and non-essential build scripts
78 |   `-- build/           Essential build scripts
79 |
80 |
81 |   BUILD PROCESS:
82 |   (also see SCRIPTS section above)
83 |
84 |-- make/                Specific make subroutine files
85 |-- stepmake/            Generic make subroutine files
86 |
87 |
88 |   REGRESSION TESTS:
89 |
90 |-- input/
91 |   `-- regression/      .ly regression tests
92 |       |-- abc2ly/      .abc regression tests
93 |       `-- musicxml/    .xml and .itexi regression tests
94 |
95 |
96 |   MISCELLANEOUS:
97 |
98 |-- elisp/               Emacs LilyPond mode and syntax coloring
99 |-- vim/                 Vi(M) LilyPond mode and syntax coloring
100 `-- po/                  Translations for binaries and end-user scripts