Help documentation

These instructions are for building a custom macro in Mingle using the Macro Development Toolkit. The toolkit is available as a gem and is available either with your Mingle download (in the <MINGLE_HOME>/tools directory where <MINGLE HOME> is the directory where Mingle is installed) or via the web on GitHub.

If installing from the local gem you can install from the folder containing the gem as follows:

% [sudo] gem install mingle-macro-development-toolkit-2.0.1.gem

If you are installing this gem from its home on GitHub then you can install it using:

% [sudo] gem install mingle-macro-development-toolkit

For information on building a macro please refer to the Mingle Macro Development Toolkit website on GitHub or the getting_started.txt in the installation folder of the gem.

To uninstall the locally installed gem run:

% [sudo] gem uninstall mingle-macro-development-toolkit

The Getting Started file and the mingle-macro-development-toolkit-2.0.1.gem are owned exclusively by ThoughtWorks, Inc., and ThoughtWorks reserves all rights therein.

We believe that it is a sound practice from legal, business and software development perspectives to always provide copyright information and license information with any software that you make available to others. We have provided this information for the Mingle Macro Development Toolkit in the LICENSE file distributed with the Toolkit. We encourage you to use that as an example to follow when marking your software with a copyright notice, as well as providing users with a license to your software. We have chosen to use the MIT License, an Open Source License, you may choose to use the same or a different license. If you are going to use an Open Source License we strongly encourage you to use a license approved by the Open Source Initiative.