Skip to content

Commit bf2486d

Browse files
committed
USING: added libclang prerequisite (BlackCAT-CubeSat#31)
Someone recently ran into this issue when getting started. Hopefully this change will keep others from running into the same problem.
1 parent 64f94f7 commit bf2486d

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Diff for: USING.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ This is what you need to do:
88

99
## Prerequisites
1010

11-
First off, you need to [install Rust], if you haven't done so already.
11+
First off, you will need the C toolchain and other build tools (_e.g._, CMake)
12+
you are using to build the rest of your cFS system.
13+
14+
Next, you need to [install Rust], if you haven't done so already.
1215
Make sure the `cargo` tool is in your `$PATH`.
1316

1417
For the time being, we need the `nightly` release channel
@@ -27,6 +30,16 @@ We also need the Rust standard library's source code
2730
$ rustup +nightly component add rust-src
2831
```
2932

33+
Finally, you will need to install `libclang` and the associated development files,
34+
as they are required for automated generation of low-level bindings to cFS C APIs.
35+
For example, on most Debian-like systems, you can run the following (as `root`):
36+
37+
```sh
38+
# apt install libclang-[n]-dev libclang1-[n]
39+
```
40+
41+
where `[n]` is a sufficiently recent version of `clang` (at time of writing, it must be at least `5`).
42+
3043
## Build system additions
3144

3245
The `cfs-sys` crate,

0 commit comments

Comments
 (0)