mirror of https://gitee.com/openkylin/cwidget.git
46 lines
1.2 KiB
Plaintext
46 lines
1.2 KiB
Plaintext
|
[[toc ]]
|
||
|
|
|
||
|
|
[[meta title="Using cwidget in your software"]]
|
||
|
|
|
||
|
|
## Compile and link flags
|
||
|
|
|
||
|
|
The program [pkg-config][] is used to dynamically discover the
|
||
|
|
appropriate compile and link flags for cwidget. If you are using
|
||
|
|
[autoconf][] to configure your source, place the following lines in
|
||
|
|
your `configure.ac`:
|
||
|
|
|
||
|
|
> PKG_CHECK_MODULES(CWIDGET, cwidget)
|
||
|
|
>
|
||
|
|
> CXXFLAGS="$CXXFLAGS $CWIDGET_CFLAGS"
|
||
|
|
> LIBS="$LIBS $CWIDGET_LIBS"
|
||
|
|
|
||
|
|
If you are not using [autoconf][], you can directly invoke
|
||
|
|
[pkg-config][] to find cwidget. Running
|
||
|
|
|
||
|
|
> pkg-config --cflags
|
||
|
|
|
||
|
|
will output the flags you should add to your compiler invocation, and
|
||
|
|
running
|
||
|
|
|
||
|
|
> pkg-config --libs
|
||
|
|
|
||
|
|
will output the flags you should add to your linker invocation.
|
||
|
|
|
||
|
|
[autoconf]: <http://www.gnu.org/software/autoconf/>
|
||
|
|
[pkg-config]: <http://pkg-config.freedesktop.org/>
|
||
|
|
|
||
|
|
## API documentation
|
||
|
|
|
||
|
|
The [API documentation][api-docs] for cwidget is generated
|
||
|
|
automatically from the source code, using [doxygen][]. The
|
||
|
|
documentation is not generated by default, so if you want to browse it
|
||
|
|
locally you must first run
|
||
|
|
|
||
|
|
> make doc
|
||
|
|
|
||
|
|
to build it.
|
||
|
|
|
||
|
|
[api-docs]: <api/index.html>
|
||
|
|
[doxygen]: <http://www.doxygen.org>
|
||
|
|
|
||
|
|
<!-- TODO: tutorial and quick-starts are needed. -->
|