<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.15">
  <compounddef id="md__docs_build" kind="page">
    <compoundname>md_Docs_build</compoundname>
    <title>Building the Kit</title>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para><heading level="2">Dependencies </heading>
</para>
<para><heading level="3">Unity</heading>
</para>
<para>Unity is required to build Unity libs.</para>
<para><heading level="3">Mono</heading>
</para>
<para>Mono is required to build assemblies and for NUnit.</para>
<para><programlisting><codeline><highlight class="normal">brew<sp/>install<sp/>mono</highlight></codeline>
</programlisting></para>
<para><heading level="3">NUnit</heading>
</para>
<para>The gulp NUnit runner has a bug that expects to find the executable with a <computeroutput>.exe</computeroutput> suffix.</para>
<para>Link to the one installed by Mono into <computeroutput>/usr/local/bin</computeroutput>.</para>
<para><programlisting><codeline><highlight class="normal">cd<sp/>/usr/local/bin</highlight></codeline>
<codeline><highlight class="normal">sudo<sp/>ln<sp/>-s<sp/>nunit-console<sp/>nunit-console.exe</highlight></codeline>
</programlisting></para>
<para><heading level="3">Node.js</heading>
</para>
<para>Required for package management.</para>
<para><programlisting><codeline><highlight class="normal">brew<sp/>install<sp/>node</highlight></codeline>
</programlisting></para>
<para><heading level="3">Doxygen</heading>
</para>
<para>Required to build docs. See <computeroutput>Doxyfile</computeroutput>.</para>
<para><itemizedlist>
<listitem><para>Graphviz for <computeroutput>dot</computeroutput> to generate doc diagrams</para>
</listitem><listitem><para>Qt for <computeroutput>qhelpgenerator</computeroutput> to generate Qt docs</para>
</listitem></itemizedlist>
</para>
<para><programlisting><codeline><highlight class="normal">brew<sp/>install<sp/>doxygen<sp/>graphviz<sp/>qt</highlight></codeline>
</programlisting></para>
<para><heading level="2">Compiling </heading>
</para>
<para><heading level="3">Install dependencies</heading>
</para>
<para>Install dependencies with npm.</para>
<para><programlisting><codeline><highlight class="normal">npm<sp/>install</highlight></codeline>
</programlisting></para>
<para>The NPM post-install script will also start a build.</para>
<para><heading level="3">Build tasks</heading>
</para>
<para>Run tasks using gulp.</para>
<para><programlisting><codeline><highlight class="normal">gulp<sp/>build</highlight></codeline>
</programlisting></para>
<para>See <computeroutput>gulpfile.ts</computeroutput> for details. </para>
    </detaileddescription>
  </compounddef>
</doxygen>
