nxdrvlinux/examples/readme.md

26 lines
876 B
Markdown
Raw Normal View History

## cifX Linux example applications
### Overview
| demo application | description |
| ------------------------------ |:-------------:|
| api | The demo shows the basic functions of the cifX API and how to use it.
| tcpserver | A demo server application which allows remote access (e.g. with Communication Studio).
1. create a build folder and enter it
```
mkdir demo_build; cd demo_build
```
2. Prepare the build environment via cmake call and pass the path to the examples lists (CMakelists.txt within examples folder) file.
Run the preparation with your required options e.g.:
```
cmake ../ -DDEBUG=ON
```
3. Build the examples and run a demo application. Note that you may need root rights. This depends on your system setup. For more information see [System and hardware setup]()
```
make
./cifx_api
```