Getting Started on OSX

Downloading the Sources

Download va from here and unpack it to a comfortable place. Starting from VirtualAwesome/ you will find three main directories. The libs directory holds all the core support libraries also including the actual va library. The addon directory holds additional libraries with non-essential functionality. And the apps directory holds all the example code.

VirtualAwesome/
  CMakeLists.txt
  addons/
    vaMice/
    vaMultipad/
    vaOpencv/
    vaTouchkit/
  apps/
    addonExamples/
      exampleMice/
      exampleMultipad/
      exampleTouchkitSimple/
    examples/
      exampleKeymouse/
      exampleShapes/
      exampleWidget/
  libs/
    va/
    osg, freetype, jpeg,  png,  zlib
    ...

Generating the Project Files

After downloading the sources you can generate the project files with cmake. This tool comes with a nice cross-platform GUI and is very much self-explanatory. In cases of doubt the following goes through the precise steps necessary.

  1. Download and install the cmake package for OSX.
  2. Run the cmake-gui, enter the two directories at the top (source and build directory). For both enter the path to VirtualAwesome/ where the master CMakeLists.txt file is located. Having them identical results in what is called an in-source build. (Out-of-source builds can cause issues with loading resource files during runtime, something to keep in mind)
  3. Press the Configure button -- cmake will ask you for the kind of project files to generate -- select Xcode.
  4. Press the Configure button again.
  5. Press the Generate button.

Building the Example Apps

At this point there is a virtualAwesome.xcodeproj project file in VirtualAwesome/. After firing up the project in Xcode simply select an example from the target drop-down and build-run it. Note that the Active Target and the Active Executable can be selected separately. So don't get confused when you build one app and another one runs. During the first run this builds the va library automatically. Subsequent runs only builds the selected example.

If you run into problems let us know on the Discussion List.

What's Next?

Writing your own apps is just one step away. Check out the guide to StartingNewApps as well as the Introduction to the API.