wiki:QuickStart

Version 2 (modified by dennisr, 8 years ago) (diff)

--

Install Apache Ant

Later on in this document, you will find information on using the HMI modules in Eclipse. It is easier, though, to start testing the whole setup using the command prompt and Apache Ant.

  • Obtain the latest version of Apache Ant (version >= 1.8.2)
  • put the ant bin directory on your PATH
  • add the following line to the starter command in ant/bin: set ANT_OPTS=-Xmx256M -XX:MaxPermSize=256M

Directory structure

Make a top level project root; unzip the release files (see Download) into this directory. Typical directory setup:

<projectroot>/HmiShared/ant
<projectroot>/HmiShared/docs
<projectroot>/HmiShared/repository
...etc
<projectroot>/HmiDemo/MyFirstProject
<projectroot>/HmiDemo/HmiAnimationDemo
...etc

If you have downloaded the source release, you will in addition have the following directories:

<projectroot>/Hmi/HmiBml
<projectroot>/Hmi/HmiAnimation
....etc

Quick start: try out first project

HmiDemo contains, among other things, an example projects for quick start of an Elckerlyc application. MyFirstProject shows how to set up an Elckerlyc project that uses the latests official binary releases of the core Hmi modules.

To try these out, duplicate the MyFirstProject demo project, put it somewhere below the <projectroot> directory, and follow the instructions in its README.TXT file.

<projectroot>/CopyOfMyFirstProject
<projectroot>/CopyOfMyFirstProject/README.txt
<projectroot>/CopyOfMyFirstProject/src
<projectroot>/CopyOfMyFirstProject/docs
...etc

First documentation pointers

When the first example project is working, you might start to read up on the setup and use of the build system, or how to use these projects in Eclipse, or try to build more complicated examples. First starting point for documentation is HmiShared/docs

Discussion

QuickStart
 unsolved

If you have additional suggestions, hints, tips, or comments, please add them here by replying to this topic.