| 1 |
[[toc ]] |
| 2 |
|
| 3 |
[[meta title="Using cwidget in your software"]] |
| 4 |
|
| 5 |
## Compile and link flags |
| 6 |
|
| 7 |
The program [pkg-config][] is used to dynamically discover the |
| 8 |
appropriate compile and link flags for cwidget. If you are using |
| 9 |
[autoconf][] to configure your source, place the following lines in |
| 10 |
your `configure.ac`: |
| 11 |
|
| 12 |
> PKG_CHECK_MODULES(CWIDGET, cwidget) |
| 13 |
> |
| 14 |
> CXXFLAGS="$CXXFLAGS $CWIDGET_CFLAGS" |
| 15 |
> LIBS="$LIBS $CWIDGET_LIBS" |
| 16 |
|
| 17 |
If you are not using [autoconf][], you can directly invoke |
| 18 |
[pkg-config][] to find cwidget. Running |
| 19 |
|
| 20 |
> pkg-config --cflags |
| 21 |
|
| 22 |
will output the flags you should add to your compiler invocation, and |
| 23 |
running |
| 24 |
|
| 25 |
> pkg-config --libs |
| 26 |
|
| 27 |
will output the flags you should add to your linker invocation. |
| 28 |
|
| 29 |
[autoconf]: <http://www.gnu.org/software/autoconf/> |
| 30 |
[pkg-config]: <http://pkg-config.freedesktop.org/> |
| 31 |
|
| 32 |
## API documentation |
| 33 |
|
| 34 |
The [API documentation][api-docs] for cwidget is generated |
| 35 |
automatically from the source code, using [doxygen][]. The |
| 36 |
documentation is not generated by default, so if you want to browse it |
| 37 |
locally you must first run |
| 38 |
|
| 39 |
> make doc |
| 40 |
|
| 41 |
to build it. |
| 42 |
|
| 43 |
[api-docs]: <api/index.html> |
| 44 |
[doxygen]: <http://www.doxygen.org> |
| 45 |
|
| 46 |
<!-- TODO: tutorial and quick-starts are needed. --> |