Skip to content

Commit b3d0ea5

Browse files
committed
readme DOC add short usage information
1 parent fbb4ac8 commit b3d0ea5

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,23 @@ Note that, with CMake, if you want to change the compiler or its options after
240240
you already ran CMake, you need to clear its cache first - the most simple way
241241
to do it is to remove all content from the 'build' directory.
242242

243+
## Usage
244+
245+
All public functions are available via 2 headers:
246+
```
247+
#include <nc_server.h>
248+
#include <nc_client.h>
249+
```
250+
251+
You need to include either one if imeplementing a NETCONF server or a NETCONF client,
252+
respectively.
253+
254+
To compile your program with libnetconf2, it is necessary to link it with it using the
255+
following linker parameters:
256+
```
257+
-lnetconf2
258+
```
259+
243260
## Tests
244261

245262
The repository includes several tests built with [cmocka](https://cmocka.org/).

0 commit comments

Comments
 (0)