From 6725e53d456d1c42fbfaa8ecc99608baf2f43911 Mon Sep 17 00:00:00 2001 From: RowanC Date: Mon, 6 Apr 2026 17:34:24 +0100 Subject: [PATCH] Its time to retire --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a8fb20d..4d723d9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -= nrai_ADS-DV_CAN-API +# nrai_ADS-DV_CAN-API This is the Newcastle Racing AI (nrai) implementation of the ADS-DV software interface specification (including all other sensors accessed via CAN e.g. GPS). it aims to be as minimal as possible, facilitating on the bare minimum to pack @@ -6,7 +6,7 @@ and unpack CAN frames, only implementing checks where required for the packing of frames (e.g. stat clamping). All data sanity checks are expected to be implemented by the calling program. -== Usage +## Usage 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. @@ -18,7 +18,7 @@ and function for the AI to unpack CAN frames, named in the format 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_` -== Notes +## 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 supported by GCC and Clang, not all compilers support them.