This file contains instructions to upgrade to a new release of Gregorio.
Because of changes necessary to future-proof the fonts, please upgrade to at least TeX Live 2013 if you are using an older version. If the neumes do not appear or look strange in the output, you may also need to clear your LuaTeX font cache by using luaotfload-tool --cache=erase.
When migrating to this release, you should start to use the new \includescore system, as other ways of score inclusion are deprecated and will start disapear soon. See GregorioRef.pdf for details.
In version 2.4.2, an early version of the feature to auto-compile gabc score was added. Because of the confusion this caused with old users upgrading to 2.4.2, the \includescore command now works in a backwards-compatible way so scores created using this command for versions of Gregorio prior than 2.4.2 should work with no change. However, for users of 2.4.2, the following changes are necessary:
- If you were using
\includescore[f], the equivalent command is now\includescore[n], but due to this change, you should be able to just use\includescorewithout the optional parameter. - If you were using the auto-compile feature, you should use
\autocompilegabcin your tex file prior to using\includescore. This is only necessary once and does not need to be used before each use of\includescore.
If you use custom space definitions (gsp-foo.tex), the format have changed, and you must rewrite it completely. See the new gsp-default.tex for an example, and GregorioRef.pdf for documentation.
If you want to change color in gabc, using the <c> markup is the safest way, and you should migrate to that, as Gregorio introduced mechanisms that may break badly formatted color changes (e.g. \color{red}foo\color{black}).