README.md
1# Generic host components for Nugget
2
3Nugget will be used in different contexts and with different hosts. This repo
4contains the components that can be shared between those hosts.
5
6## `nugget`
7
8The `nugget` directory contains items that are shared between the host and the
9firmware. Those include:
10
11 * shared headers
12 * service protos
13
14## `libnos`
15
16`libnos` is a C++ library for communication with a Nugget device. It offers an
17interface to manage a connection and exchange data and a generator for RPC stubs
18based on service protos.
19
20## `libnos_datagram`
21
22`libnos_datagram` is a C library for exchanging datagrams with a Nugget device.
23This directory only contains the API of the library as the different platforms
24will need to implement it differently.
25
26## `libnos_transport`
27
28`libnos_transport` is a C library for communicating with a Nugget device via the
29transport API. This is built on top of the `libnos_datagram` library for
30exchanging datagrams.
31