Changes between Version 2 and Version 3 of QuickStart


Ignore:
Timestamp:
07/12/11 12:23:08 (8 years ago)
Author:
dennisr
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • QuickStart

    v2 v3  
     1== Install Java == 
     2Elckerlyc requires Java 1.6 or greater. 
     3 
    14== Install Apache Ant == 
    25Later 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. 
     
    2629!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. 
    2730 
    28 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. 
     31To try these out, do the following. 
     32 
     331) Duplicate the !MyFirstProject demo project, put it somewhere below the <projectroot> directory. 
    2934{{{ 
    3035<projectroot>/CopyOfMyFirstProject 
    3136<projectroot>/CopyOfMyFirstProject/README.txt 
     37<projectroot>/CopyOfMyFirstProject/ivy.xml 
     38<projectroot>/CopyOfMyFirstProject/build.xml 
     39<projectroot>/CopyOfMyFirstProject/manifest.mf 
    3240<projectroot>/CopyOfMyFirstProject/src 
    3341<projectroot>/CopyOfMyFirstProject/docs 
     
    3543}}} 
    3644 
     45 
     462) Modify the contents of ivy.xml, build.xml, manifest.mf: the MyFirstProject name, mentioned in those files, should be changed to the name of your new project (in this example: !CopyOfMyFirstProject) 
     47 
     483) Modify build.xml to have the correct relative path to the HmiShared repository (see below for this example) 
     49{{{ 
     50<?xml version="1.0" encoding="UTF-8"?> 
     51<project name="CopyOfMyFirstProject"  default="run"> 
     52   <import file="../HmiShared/ant/build.xml" />     
     53</project> 
     54}}} 
     55 
     564) in command prompt, in the directory `<projectroot>/CopyOfMyFirstProject`,  do  
     57 * "ant resolve"  to collect all dependent external libraries and resources into `<projectroot>/CopyOfMyFirstProject/lib` 
     58 * "ant compile"    to compile this project 
     59 * "ant run"    to run demo class in this project 
     60 
     615) If all went well, you will see a window appear with an avatar. Use the dialog window to send some example BML to the avatar. 
     62 
     636) '''A note on resources''' 
     64 
     65 
     66 
    3767== First documentation pointers == 
    3868When 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