From 0970f56c554b777fc572b3e09c6e8dd6d57e025c Mon Sep 17 00:00:00 2001
From: Zachary Catlin <zec0@psu.edu>
Date: Mon, 13 Nov 2023 11:50:35 -0500
Subject: [PATCH 1/2] USING: added libclang prerequisite (#31)

Someone recently ran into this issue when getting started.
Hopefully this change will keep others from running into the same problem.
---
 USING.md | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/USING.md b/USING.md
index 7bf6a70e..82a61b9c 100644
--- a/USING.md
+++ b/USING.md
@@ -8,7 +8,10 @@ This is what you need to do:
 
 ## Prerequisites
 
-First off, you need to [install Rust], if you haven't done so already.
+First off, you will need the C toolchain and other build tools (_e.g._, CMake)
+you are using to build the rest of your cFS system.
+
+Next, you need to [install Rust], if you haven't done so already.
 Make sure the `cargo` tool is in your `$PATH`.
 
 For the time being, we need the `nightly` release channel
@@ -17,16 +20,26 @@ If you're using `rustup` to manage your Rust installation, this will add
 that channel:
 
 ```sh
-$ rustup toolchain install nightly
+rustup toolchain install nightly
 ```
 
 We also need the Rust standard library's source code
 (for reasons relating to how we handle panics):
 
 ```sh
-$ rustup +nightly component add rust-src
+rustup +nightly component add rust-src
+```
+
+Finally, you will need to install `libclang` and the associated development files,
+as they are required for automated generation of low-level bindings to cFS C APIs.
+For example, on most Debian-like systems, you can run the following (as `root`):
+
+```sh
+apt install libclang-[n]-dev libclang1-[n]
 ```
 
+where `[n]` is a sufficiently recent version of `clang` (at time of writing, it must be at least `5`).
+
 ## Build system additions
 
 The `cfs-sys` crate,

From 839a6fc3f1819d0fc6025d322e8bdb8d18eff9ca Mon Sep 17 00:00:00 2001
From: Zachary Catlin <zec0@psu.edu>
Date: Tue, 14 Nov 2023 13:13:53 -0500
Subject: [PATCH 2/2] USING: changed wording regarding libclang versions

---
 USING.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/USING.md b/USING.md
index 82a61b9c..18ec0421 100644
--- a/USING.md
+++ b/USING.md
@@ -38,7 +38,8 @@ For example, on most Debian-like systems, you can run the following (as `root`):
 apt install libclang-[n]-dev libclang1-[n]
 ```
 
-where `[n]` is a sufficiently recent version of `clang` (at time of writing, it must be at least `5`).
+where `[n]` is some version of `clang` (generally, the newer the better,
+but [version 5 at minimum]).
 
 ## Build system additions
 
@@ -198,6 +199,7 @@ You can find a fully worked-out example of a Rust-using cFS application at
 [install rust]: https://www.rust-lang.org/tools/install
 [1]: https://rust-lang.github.io/rustup/concepts/channels.html
 [2]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
+[version 5 at minimum]: https://rust-lang.github.io/rust-bindgen/requirements.html
 [a little configuration]: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-reads
 [shared compile caches]: https://doc.rust-lang.org/cargo/guide/build-cache.html#shared-cache
 [sccache]: https://github.com/mozilla/sccache