Migration to GitHub

This project has migrated to GitHub. All releases, starting with 3.0.0-rc1, and documentation updates will be made available there. This website will be allowed to remain for those looking for documentation for older releases.


Installing Gregorio under MAC OS

The TeX distribution

The first step to make Gregorio work is to have a TeX distribution: MacTeX or TeXLive. See the official site for instructions.

The installer

An installer has been created for some Mac systems. It is available from the download page, meant for systems running OS X versions 10.5 or later.

WARNING: Recently many people have reported difficulties with getting Gregorio to work after using the installer and to date no one has been able to identify just which systems the installer works for and which it doesn't. It may be related to the fact that the installer puts things in unusual locations, but no one is currently working on the development of the installer package, so don't expect it to magically get better anytime soon. If you try the installer and things don't work then delete everything that the installer placed on your system (to prevent conflicts with the new version) and try compiling directly from the sources according to the directions below.

The simplest way to clear out the files placed on your computer by the installer is to execute the following commands in Terminal:

$ sudo rm /usr/bin/gregorio
$ sudo rm -r /usr/include/gregorio
$ sudo rm /usr/lib/pkconfig/gregorio.pc
$ sudo rm -r /usr/local/texlive/texmf-local/tex/gregoriotex
$ sudo rm -r /usr/local/texlive/texmf-local/tex/latex/gregoriotex

Oh, and if you know something about creating Mac installers and are willing to help fix ours, please get in touch.

Compiling from sources

Development environment installation

To be able to compile Gregorio, you must first install an installation environment. Here are the main guidelines:

  1. download XCode (free) from the Apple Mac App Store
  2. lauch it, it will first want to install a device manager, install it
  3. under Preferences, click on Downloads and install the Command Line Tools
  4. download and install MacPorts (free)
  5. once installed, in the TERMINAL, do sudo port selfupdate to get the latest sources packages
  6. do sudo port install libtool autoconf automake flex bison libxml2.

Once all this is done, you should be able to compile Gregorio.

If you want to compile fonts (to modify them), do sudo port install fontforge.

Source downloading

You have a choice between versions of Gregorio. To obtain the sources of the stable version, you just need to download the sources from the download page, and decompress the archive.

To get the git version, that is, the version in development (more functionalities, but might contain more bugs), you will have to create a local copy of the gitn repository of the project, with the command:

$ git clone https://github.com/gregorio-project/gregorio.git gregorio-git $ cd gregorio-git


Once the sources are downloaded, carry out the following commands in the directory containing the source files:

$ autoreconf -f -i (if you have the git version)
$ ./configure CFLAGS='-I/opt/local/include' CPPFLAGS='-I/opt/local/include' LDFLAGS='-L/opt/local/lib'
$ make
$ sudo make install
$ cd fonts
$ sudo make install


To update your git version, you just need to go in the directory containing the source files (assuming you kept it), run git pull origin master and recompile with the same instructions as the previous Compilation section. If you deleted that directory after install, then just repeat the steps above starting at the git clone command.

Last modification: 21 August 2015.


This document and the design of this site (by Patrick Roux) are under GPL.