===============================================================================
BrainStem2CLI Readme:
===============================================================================
This is a C# example for the BrainStem2CLI library.

Notes:
===============================================================================

* To build, copy the "lib" directory from "..\..\..\..\api" into the project 
  directory containing this readme file. The lib directory contains the 
  required files to build an application.

* In the event that the example does not build correctly the following steps
    should be taken.
    1.  Ensure that BrainStem2CLI.dll is added as a reference to the project.
    2.  Add "using Acroname.BrainStem2CLI" to the top of the "Program.cs" file.
    3.  Confirm that the post build step is being preformed properly (Project >
        Properties > Build Events > Post-Build event command line).
        a.  The BrainStem2.dll needs to be copied to the output directory.
            "copy $(ProjectDir)lib\w32\BrainStem2.dll $(ProjectDir)$(OutDir)"
        b.  The libczmq*.dll needs to be copied to the output directory.
            "copy $(ProjectDir)lib\w32\libczmq*.dll $(ProjectDir)$(OutDir)"
        c.  The libzmq*.dll needs to be copied to the output directory.
            "copy $(ProjectDir)lib\w32\libzmq*.dll $(ProjectDir)$(OutDir)"

* When deploying your project ensure that you are using Release mode so that
  all required dependencies are included.

* The .NET library is a C++/CLI wrapper around our C/C++ library.  Therefor, we
  still depend on many of the defines located in the header files. (lib/BrainStem2/)
    - Device specific defines can be found in their respective header files.
      i.e. The number of USB ports found on the USBHub3p is defined in "aUSBHubp3.h"
    - Software/Protocol/Entity specific defines can be found in "aProtocoldefs.h"
      i.e. Digital Entity configuration options (input, output, highz, etc).

* Native code debugging must be enabled in order to properly debug an application
  using the Acroname .NET API. This setting can be found in the Project Properties
  under Debug > Enable native code debugging. Failure to enable this feature 
  typically causes a crash at: "stem.module.discoverAndConnect".


If you have questions, please see the reference, or check out our guides
at www.acroname.com.
