Getting started with the Ground Truth Engine (GTE) project

[apsexton]

The following is written in terms of using Eclipse. However, there is no requirement that Eclipse is used so please substitute any IDE that is supported by your environment.

1. Clone the repository
2. Set up your Eclipse environment
   • keep your repository clone in a different folder from your eclipse folder (see https://wiki.eclipse.org/EGit/User_Guide#Creating_Repositories for why, though you don't need to create a repository, just clone this one.)
   • Make sure you are using a recent Java JDK (e.g. 1.8 or later)
   • Make sure you are using a recent Eclipse (e.g Mars 1 Release 4.5.1 or later)
3. Set up the "gte" (and "layout" if you want) project in Eclipse
   1. Start Eclipse and make sure your workspace is different from (not contained in or containing) your repository folder
   2. File|Import|Git|Projects from Git... Select "Existing local repository" and add the local repository directory (bateman-ocr)
   3. Select Import existing Eclipse Projects" and "Next"
   4. At this point, it should show you the "gte" and "layout" projects. Select and them and finish.
   5. The Java perspective is probably not open so open it:
      • Window|Perspective|Open Perspective|Java
   6. Set your Run Configuration:
      1. Click on the drop down box beside the green run arrowhead in the top toolbar
      2. Run Configurations...
      3. Double click on Java Applications, set the name to "gte", Project to "gte" and click search to get the Main class (gte.main) and click "Apply"
      4. Make sure you can run the gte application by clicking on the green arrowhead.
   7. You may want to open the git perspective (Window|Perspective|Ope Perspective|Other...|Git) or just open the git repository and staging views (Windows|Show View|Other...|Git and select Git Repositories and Git Staging.
4. Familiarise yourself with the code, the Model/View/Controller structure, and specifically how actions work and are added to the menus, toolbars and have keyboard accelerators assigned

[kevinshen100]

i have completed this issue, and set up the project in IntelliJ.