diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-22 13:44:06 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-22 13:44:06 +0200 |
| commit | 5113ffd3b0b3c761681456fae5ed554c2b35cc8d (patch) | |
| tree | aca4ab94dac1522455cae7ee445149949ddb233b /lib/i2ctcp/readme.md | |
| parent | bb63040692c94ffa662b0af7eb14f3c5951aa6e6 (diff) | |
add i2ctcp to doxygen
Diffstat (limited to 'lib/i2ctcp/readme.md')
| -rw-r--r-- | lib/i2ctcp/readme.md | 25 |
1 files changed, 0 insertions, 25 deletions
diff --git a/lib/i2ctcp/readme.md b/lib/i2ctcp/readme.md deleted file mode 100644 index d5bfe6d..0000000 --- a/lib/i2ctcp/readme.md +++ /dev/null @@ -1,25 +0,0 @@ -# i2ctcp (I<sup>2</sup>C over TCP) - -This folder includes protocol (de)serialization functions for sending and -receiving I<sup>2</sup>C messages over TCP. These functions are used by the -[main controller](../main) and the [puzzle box client (pbc)](../client). This -folder does not include any puzzle bus specific code, and the headers for -puzbus are in the [shared](../shared) folder instead. - -[MessagePack][msgpack] (specifically the [mpack][mpack] implementation) is used -for the actual serialization/deserializtion, and the functions in this folder -act as helpers for parsing from chunked data streams. - -To use these functions, include the following statement in your CMakeLists.txt: -```cmake -include(../i2ctcp/include.cmake) -``` - -The functions are available by `#include`ing the `i2ctcpv1.h` header, and are -extensively documented using Doxygen-style comments. - -[msgpack]: https://msgpack.org/ -[mpack]: https://github.com/ludocode/mpack/ - - - |