| 1 |
# Gregorio |
| 2 |
|
| 3 |
Gregorio is a software application for engraving Gregorian Chant scores on a computer. Gregorio's main job is to convert a [gabc file](http://gregorio-project.github.io/gabc/index.html) (simple text representation of a score) into a [GregorioTeX file](http://gregorio-project.github.io/gregoriotex/index.html), which makes [TeX](http://gregorio-project.github.io/gregoriotex/tex.html) able to create a PDF of your score. |
| 4 |
|
| 5 |
## Usage |
| 6 |
|
| 7 |
Create a `.gabc` file representing your score (see our [tutorial](http://gregorio-project.github.io/tutorial/tutorial-gabc-01.html)), or fetch one from [the database](http://gregobase.selapa.net/). |
| 8 |
|
| 9 |
Create a [LaTeX](http://en.wikipedia.org/wiki/LaTeX) file that will produce the final pdf, and include your score. See [the example](examples/main-lualatex.tex). |
| 10 |
|
| 11 |
Compile the LaTeX file with LuaLaTeX, you get your score in PDF! You can change the LaTeX file to include other scores, create booklets, books, etc. |
| 12 |
|
| 13 |
You can also try it online [here](http://dev.illuminarepublications.com/). |
| 14 |
|
| 15 |
## Installation |
| 16 |
|
| 17 |
You need a recent and working [TeX Live](https://www.tug.org/texlive/), on top of which you just need to install latest [Gregorio release](https://github.com/gregorio-project/gregorio/releases). See [the website](http://gregorio-project.github.io/installation.html) for more details. |
| 18 |
|
| 19 |
## Building for inclusion in TeX Live |
| 20 |
|
| 21 |
When building gregorio for inclusion in TeX Live, the gregorio executable must not have the version number suffix that is used for other builds. To make this happen, run `configure` with the `--disable-version-in-exe` option, and the generated Makefile will create a gregorio executable without the version number suffix (i.e., the executable will simply be named `gregorio`). |
| 22 |
|
| 23 |
## Documentation |
| 24 |
|
| 25 |
You can find documentation and useful links in the [documentation](doc/), on [the main website](http://gregorio-project.github.io/) and on [a wiki](http://gregoriochant.org). |
| 26 |
|
| 27 |
## History |
| 28 |
|
| 29 |
See [CHANGELOG.md](CHANGELOG.md). |
| 30 |
|
| 31 |
## Credits |
| 32 |
|
| 33 |
See [CONTRIBUTORS.md](CONTRIBUTORS.md). |
| 34 |
|
| 35 |
## Contributing and bug reporting |
| 36 |
|
| 37 |
See [CONTRIBUTING.md](CONTRIBUTING.md). |
| 38 |
|
| 39 |
## License |
| 40 |
|
| 41 |
The code is mainly under the [GPLv3](https://www.gnu.org/licenses/quick-guide-gplv3.en.html) license, with fonts under the [Open Font License](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL). See [complete license](COPYING.md) for more details. |