Skip to content

Commit 3fe1490

Browse files
readme
1 parent c9db140 commit 3fe1490

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,16 @@
1212
Portable reference implementation of the [Cyphal protocol stack](https://opencyphal.org) in C++ for embedded systems, Linux, and POSIX-compliant RTOSs.
1313

1414
Cyphal is a lightweight protocol designed for reliable communication in aerospace and robotic applications over robust vehicular networks.
15+
16+
## Building
17+
18+
You don't need to build LibCyphal to use it since this is a header-only library. You will need to build the transport libraries though (libcanard, libudpard, etc), which is covered in their respective documentation.
19+
20+
If you want to build libcyphal for development purposes, you may use containerized toolchains as covered in CONTRIBUTING.md. Otherwise, you may want to disable static analysis:
21+
22+
```shell
23+
mkdir build
24+
cd build
25+
cmake .. -DNO_STATIC_ANALYSIS=1
26+
make -j16
27+
```

0 commit comments

Comments
 (0)