Installing Gregorio under Windows

The first step for a simple install of gregorio under Windows is to install TeXLive:

Installing TeXLive

To install Gregorio and its TeX package GregorioTeX, you will first need a complete TeX system (called a distribution). There are various TeX distributions. The two most prominent for Windows are:

As TeXLive is the system used on Linux and Mac, we have chosen to describe the installation of TeXLive. However, the installer will also with MiKTeX should that be your distribution of choice.

To begin, download the latest TeXLive installer from the official site and unzip it. Then you have three options:

The first is to launch install-tl.bat and to say yes all the time (though you may want to switch the default paper size to "Letter" if you are in the United States), it will simply install all the TeXLive distribution (about 4GB). If you have the space (and the time) we strongly recommend using this option. Furthermore, in TeXLive 2016 and later, this process will install Gregorio, allowing you to skip the remainder of these instructions (unless you want a more recent version of Gregorio than what shipped with the version of TeXLive that you are installing).

If you have less time or disk space, launch install-tl-advanced.bat. A graphical interface will open to give you the installation options. Click on the uppermost "Change" button, to select the medium scheme. Click then on the second "Change" button and add "LaTeX additional packages" to the selections. In TeXLive 2016 you can also add "Music packages", as it contains Gregorio, though if you intend to install a more recent version of Gregorio, you can leave that off and just follow the directions below. To save some space, you can also unselect the languages you don't need (Latin is in the "Other European languages"), "ConTeXt and packages", and "XeTeX and packages". The space required for installation should be about 1.5GB. If you are in the United States you may also want to toggle the default paper size to "letter".

For a truly minimal installation (as far as Gregorio is concerned), launch install-tl-advanced.bat. Click on the uppermost "Change" button, to select the basic scheme. Click then on the second "Change" button and add "LuaTeX packages" (you might also want to add "TeXworks editor" unless you plan to compile documents from the commandline)". After installation, you will then need to launch TeXLive Manager and add the following packages: xcolor, luaotfload, and xstring at a minimum. In TeXLive 2016 and later you can also use TeXLive Manager to install Gregorio (look for gregoriotex). This included package, however, is only updated annually when TeXLive updates. For more recent versions of Gregorio you'll need to follow the directions below. Depending on what you are doing, you may also need to add other packages. The space required for this installation starts at about 300MB, but may be higher if you require more packages. If you are in the United States you may also want to toggle the default paper size to "letter".

Once you have activated the installation choices, click on "Install TeXLive". The installation may take a while, because it requires downloading the necessary packages.

If you are using MiKTeX, we recommend that you get a complete installation since it will provide you with the most flexibility going forward, we understand that not everyone has the disk space or time to install the roughly 4GB of material that this requires. If you are trying to maintain a slimmer installation, you will need to ensure that you have the following packages installed: xcolor, kvoptions, ifluatex, graphicx, luatexbase, luaotfload, luamplib, and xstring. Most of these packages should come with the LuaTeX engine, but at least xcolor and xstring are not. Like TeXLive, MiKTeX also has a version of Gregorio included, but one which is only updated anually.

Installing Gregorio

Once you've installed TeXLive, you have to restart your computer before you can install gregorio. Once you have done that, you can find a Windows auto-installer called gregorio-##-setup.exe (where ## is the version number) available in the Download section for the more recent releases. Simply follow the steps and the installation will be complete!

Next steps

It can be very helpful to configure TeXworks for Gregorio. Once you have done so, refer to the introduction page to start using Gregorio!

Troubleshooting

If you can't get Gregorio to work after following the above steps, then please report your problem and we'll try to help you fix it. In order to make this process go as quickly as possible, please run system-setup.bat and include the contents of the generated log file as part of your report. You can find system-setup.bat in the destination directory you selected when running the installer, or download it directly from GitHub. Once you've found the file in Windows Explorer, simply double click on the icon to run it.