Skip to content

Commit 76406e2

Browse files
authored
Update README.md
1 parent d2c4169 commit 76406e2

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@ MAC-layer interfaces. The core of `libcsp`
1010
includes a router, a connection oriented socket API and
1111
message/connection pools.
1212

13-
The protocol is based on a 32-bit header containing both transport and
13+
The protocol is based on an very lightweight header containing both transport and
1414
network-layer information. Its implementation is designed for, but not
15-
limited to, embedded systems such as the 8-bit AVR microprocessor and
16-
the 32-bit ARM and AVR from Atmel. The implementation is written in GNU
17-
C and is currently ported to run on FreeRTOS, Linux (POSIX).
18-
The primiary platforms being used are FreeRTOS and Linux.
15+
limited to, embedded systems with very limited CPU and memory resources.
16+
The implementation is written in GNU C and is currently ported to run on FreeRTOS, Zephyr
17+
and Linux (POSIX).
1918

2019
The idea is to give sub-system developers of cubesats the same features
2120
of a TCP/IP stack, but without adding the huge overhead of the IP
@@ -27,7 +26,7 @@ several advantages compared to the traditional mater/slave topology used
2726
on many cubesats.
2827

2928
- Standardised network protocol: All subsystems can communicate with
30-
eachother
29+
eachother (multi-master)
3130
- Service loose coupling: Services maintain a relationship that
3231
minimizes dependencies between subsystems
3332
- Service abstraction: Beyond descriptions in the service contract,
@@ -55,11 +54,15 @@ to have some rather advanced features as well.
5554
- Very Small Footprint in regards to code and memory required
5655
- Zero-copy buffer and queue system
5756
- Modular network interface system
58-
- OS abstraction, currently ported to: FreeRTOS, Linux (POSIX)
59-
and Windows
57+
- OS abstraction, currently ported to: FreeRTOS, Zephyr, Linux
6058
- Broadcast traffic
6159
- Promiscuous mode
62-
- Truncated HMAC-SHA1 Authentication (RFC 2104)
60+
61+
## Documentation
62+
63+
The latest version of the /doc folder is compiled to HTML and hosted on:
64+
65+
[libcsp.github.io/libcsp/](https://libcsp.github.io/libcsp/)
6366

6467
## Software license
6568

0 commit comments

Comments
 (0)