Overview

The code we provide is very symmetric across the platforms we support.  This requires just a few details in a project system to get the examples and sources to build in a new project.  In addition, the organization is all structured to be path relative throughout so that the entire tree can readily be moved.  Everything lives beneath one root tree. 

Our examples are structured to be "external" code that lives outside the root directory for acroname supported software.  The examples are a good way to see the structure you can use to take advantage of the Acroname libraries, sources, and example code. 

The expected organization is to have a working directory that we will call "sandbox" in this discussion.  In this directory are the two relevant directories with the "acroname" directory containing all the constant files built by Acroname and the "examples" directory that shows some simple projects that rely on the location and existence of the "acroname" directory for libraries, includes, etc. 

Example directory hierarchy.

In this article, we will walk through the steps required to make another directory named "usercode" that will contain one or more projects that use the acroname directory, but don't modify the files there. 

Sticking with this structure allows frequent updates (replace the acroname or examples directory) to the provided code from Acroname without any collisions with the user code. 

There are a few simple general tasks to do in setting up a project. 

• Establish a global #define for the OS type (aUNIX, aWIN, or aUNIX/aMACX). 
• Add an include path to find the Acroname includes. 
• Add the required Acroname libraries that will be used in the project. 

Below we break down the specific settings for the supported, default build environments for out supported platforms.  There are many other choices for build environments and we cannot hope to cover them all.  The details shown here should translate to your particular project environment with little difficulty provided you are fully familiar with your chosen project environment.