From 66a3f5dc92dad9e585246a8922e26db9b14b4b0f Mon Sep 17 00:00:00 2001 From: RowanC Date: Wed, 11 Nov 2026 22:51:05 +0000 Subject: [PATCH] Spelling and wording changes --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4d723d9..46ca8ff 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,16 @@ implemented by the calling program. This API provides 2 structs for storing data to be written to, and received from the VCU over CAN. They are `nrai_can_ai_read` and `nrai_can_ai_write` for data received from the VCU and data to write to the VCU respectively. -This API provides functions for the AI to pack data into CAN frames, named in +This API provides functions for the client to pack data into CAN frames, named in the format `int32_t nrai_can_mkframe_(struct nrai_can_ai_write *, struct can_frame *);` -and function for the AI to unpack CAN frames, named in the format +and functions for the client to unpack CAN frames, named in the format `int32_t nrai_can_unpack_(struct nrai_can_ai_read *, struct can_frame *);`. This API also provides an enum for translating CAN message names into their ID, -all entry's are named in the format `NRAI_CAN_ID_` +all entries are named in the format `NRAI_CAN_ID_`, As well as enums +for values contained within frames (see header file). ## Notes -This API makes use of limited use of C23 extensions for the purpose of either -improving clarity or simplifying code. While all C23 extensions used are +This API makes use of limited use of C23 extensions where their use either +improves clarity or simplifies code. While all C23 extensions used are supported by GCC and Clang, not all compilers support them.