Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
tridge committed Jun 5, 2023
1 parent 8ddb1f1 commit 3439e5c
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,15 @@ ctest .

There is no dedicated documentation for the library API, because it is simple enough to be self-documenting.
Please check out the explanations provided in the comments in the header file to learn the basics.
Most importantly, check out the demo application under `tests/demo.c`.
Also use [code search to find real life usage examples](https://github.com/search?q=libcanard&type=Code&utf8=%E2%9C%93).
Most importantly, check out the `examples/` directory for fully worked examples

For generation of de-serialisation and serialisation source code, please refer https://github.com/dronecan/dronecan_dsdlc .

## C++ Interface

The C++ interface is in the canard/ directory. See
`examples/ESCNode_C++` for a fully worked example of the C++ API.

## Library Development

This section is intended only for library developers and contributors.
Expand Down

0 comments on commit 3439e5c

Please sign in to comment.