Environment

Setting up development environment

This is a short guide on how to set up an environment for Audiveris' development. Although not required, we strongly recommend to use a good Java IDE that can be a great time saver. The two most popular IDEs for Java development - Eclipse and Netbeans - will be covered in this guide.

Prerequisites

First of all, you'll need the following development tools installed and working:

• Java Development Kit (JDK) version 7 or later (version 8 is recommended).
• Git version control system. It's the key part of each development package and will most likely be automatically installed with the development tools for your system. Otherwise, it's easy to find a Git package for your system elsewhere.
• Gradle command line tool is required for building Audiveris from source.

Besides the above mentioned tools you'll need to have Tesseract language files for Tesseract OCR to work properly. Please keep in mind that Tesseract is mandatory for both building and running Audiveris. It's currently not possible to use Audiveris without Tesseract.

You'll need at least the english language data. Other required languages can be installed, too. Please check this guide for further details.

Setting up Audiveris development in Netbeans IDE

• you'll need to install the Gradle plugin in Netbeans first. Go to Tools menu, choose the Plugins item, then select Available Plugins. Search for Gradle Support, check its box and hit the Install button.

• clone or download Audiveris' source code to a directory of your choice.

• get back to Netbeans, select File->Open Project and navigate to the directory you've just cloned the source code to. Netbeans should recognize a Gradle-based project there. Open it and everything should be set up automatically.

Setting up Audiveris development in Eclipse IDE

The latest version of Eclipse already includes Gradle support via Gradle's official Buildship plugin. As opposite to Netbeans, Eclipse doesn't automatically recognize Gradle projects during file opening. You need to import Gradle projects explicitely.

In Eclipse Neon, go to File->Import..., select Gradle Project from Gradle folder and click the Next button.

Navigate to the root directory of the Audiveris project and click Finish.

Importing the project will take a while because dependencies need to be downloaded first. After Eclipse has completed the import process, you can navigate through the sources in the Project Explorer (select Window->Show View->Project Explorer) or run project's tasks in Gradle tasks.