h1. Installing AMC on macOS

The installation guide requires some knowledge about Unix tools, the use of command lines, the installation of "MacPorts":http://www.macports.org. You must also have administrative rights on the computer. It is therefore not intended for everyone.

h2. Prerequisites

To work with its interface, AMC requires an X Window System or X11 graphical environment, the Linux Libertine font, the DejaVu font family, and the MacPorts installation system.

h3. X Window System environment

MacOS does not contain the standard X11 graphical environment. It is possible to fill this gap by installing XQuartz, an X Windows System environment running macOS. You can download the application on the XQuartz site. "XQuartz":http://xquartz.macosforge.org.

h3. Linux Libertine font

Linux Libertine font is a free font that covers code pages for Latin languages​​, Greek, Cyrillic languages​​, Hebrew, the International Phonetic Alphabet (and other). You need to download the package "OTF" on "LinuxLibertine.org":http://www.linuxlibertine.org site.

*Caution* : XQuartz does not recognize the fonts installed in the user's folder. You must install the fonts by moving them in the "@/Library/Fonts@" folder.

h3. DejaVu font family

DejaVu fonts are used for generating documentation in Japanese. You need to download the fonts on "dejavu-fonts.org":http://dejavu-fonts.org/wiki/Download site.

*Caution* : XQuartz does not recognize the fonts installed in the user's folder. You must install the fonts by moving them in the "@/Library/Fonts@" folder.

h3. MacPorts

MacPorts is a system that compiles, installs and manages open source software. You need to download the installation package for your version of macOS from the "MacPorts":http://www.macports.org and install MacPorts. Follow the instructions carefully and don't forget to install Xcode.

h2. Installing AMC

It is possible to install one of the two versions of AMC. Either the @stable@ version (currently, version 1.3.0.2132 of 20/11/2017), or the @development@ version. The @stable@ version evolves slowly and version changes are infrequent. Several months or years may pass between two version changes. The @development@ version is subject to more frequent changes. Some of the new features have not been fully tested and may not work as expected.

It is not possible to install both the @stable@ and the @development@ version. If one of these versions is installed, you must uninstall it before installing the other version.

For installation and operation AMC requires a @LaTeX@ environment. The standard installation will use MacPorts to install this environment. If you are using "MacTeX":http://www.tug.org/mactex/ and want AMC to use @MacTeX@ instead of the MacPort environment, the installation process differs from the standard installation. You will install the Perl programming language that is necessary for the operation of AMC. Then you should follow either the instructions of the standard installation, or those of the installation of a version of AMC using MacTeX. These descriptions assume that you have a fresh and up-to-date MacPorts installation.

h3. Installing Perl 5.26

MacPort is in a transition phase from version 5.24 to version 5.26 of Perl. To avoid malfunctions, you must force the installation of version 5.26.

<pre>sudo port install perl5 +perl5_26</pre>

h3. Standard installation

The standard installation uses MacPorts to install the LaTeX environment needed by AMC. Use the following command to install the @stable@ version of AMC.

<pre>sudo port install auto-multiple-choice</pre>

Or use the following command to install the @development@ version of AMC.

<pre>sudo port install auto-multiple-choice-devel</pre>

h3. Installing AMC for use with MacTeX

MacPorts build tools must be able to access MacTeX tools. For example, with the MacTeX 2017 installation, these tools are available in the @"/Library/TeX/texbin"@ folder. The MacPorts configuration needs to be changed to include this folder in MacPorts @path@.

Be careful, as noted in the "MacPorts documentation":https://guide.macports.org/chunked/internals.configuration-files.html, changing MacPorts' @path@ can have unpredictable effects and consequences for others tools. It must be avoided.

Edit the @/opt/local/etc/macports/macports.conf@ file to add the following line.

<pre>binpath               /opt/local/bin:/opt/local/sbin:/bin:/sbin:/usr/bin:/usr/sbin:/Library/TeX/texbin</pre>

For the stable version of AMC, you must start the installation with the following command.

<pre>sudo port install auto-multiple-choice +mactex</pre>

And for the development version of AMC it is necessary to use the command which follows.

<pre>sudo port install auto-multiple-choice-devel +mactex</pre>

The installation may take a while. When it is complete and if there is no error, AMC is ready to be used.

h2. Using AMC

You can start from the terminal or from XQuartz.

h3. In the Terminal

<pre>auto-multiple-choice</pre>

This command will launch XQuartz and AMC application.

h3. In XQuartz

Start XQuartz application.

!xquartz.png!

We can immediately set XQuartz to facilitate the launch of AMC. Open the @Applications > Customize...@ menu.

!xquartz-menu-applications-personnaliser.png!

In the Personalization window, click the button @Add an entry@.

!xquartz-fenetre-personnaliser-menu-applications.png!

Set "@Auto Multiple Choice@" in the @Name@ column and "@auto-multiple-choice@" in the @Command@ column of the new menu item.

!xquartz-fenetre-personnaliser-menu-applications-2.png!

Close the Customize window, then select the @Applications > Auto Multiple Choice@ menu.

!xquartz-menu-applications-amc.png!

AMC window should appear.

!auto-multiple-choice-window.png!

Auto-multiple-choice is now ready to work.

h2. Links

* DejaVu fonts, "http://dejavu-fonts.org/wiki/Download":http://dejavu-fonts.org/wiki/Download

* Linux Libertine font, "LinuxLibertine.org":http://www.linuxlibertine.org

* MacPorts, "http://www.macports.org":http://www.macports.org.

* MacTeX, "http://www.tug.org/mactex/":http://www.tug.org/mactex/

* XQuartz, "http://xquartz.macosforge.org":http://xquartz.macosforge.org.