reformat example readmes

Author: CameronBrooks11

examples/arduino_peripheral/README.md

@@ -1,26 +1,25 @@
-Arduino peripheral examples
-==========================
+# Arduino peripheral examples
+
+## Purpose
 
-Purpose
--------
 These sketches turn an Arduino (or compatible MCU board) into a simple I2C peripheral so the `examples/*` programs can be tested using real hardware.
 
-What’s here
------------
+## What’s here
+
 - `arduino_simple_peripheral/` — maintains a single byte register that can be written/read via I2C.
-- `arduino_multiplier_peripheral/` — simple demo: writes an input X, stores R = X*5, serves R on request.
+- `arduino_multiplier_peripheral/` — simple demo: writes an input X, stores R = X\*5, serves R on request.
+
+## Safety & wiring
 
-Safety & wiring
----------------
 - Connect SDA, SCL and GND between your host SBC (Raspberry Pi etc.) and the Arduino board. DO NOT connect 3.3V <-> 5V without level shifting if your host uses 3.3V.
 - Sketches use `Wire` library and expect slave address `0x40` by default — adjust as needed.
 
-How to use
-----------
+## How to use
+
 1. Flash one of the sketches to your Arduino.
 2. Wire: connect GND to GND, SDA to SDA, SCL to SCL on the host.
 3. Run the host-side example that matches the sketch (e.g. `master_multiplier_*`) and set the bus path if necessary: e.g. `Wire.begin("/dev/i2c-1")` in the example binaries.
 
-Notes
------
+## Notes
+
 - These sketches are examples only — use real device datasheets and level-shifting practices in production setups.

examples/c/README.md

@@ -1,22 +1,21 @@
-Examples — C
-===============
+# Examples — C
+
+## Purpose
 
-Purpose
--------
 This folder contains small C example programs that exercise the linux-wire C API (examples/cpp are the C++ equivalents).
 
-Safety first — read before running
--------------------------------
-- These examples talk to /dev/i2c-* devices. That is literal hardware (buses and devices).
+## Safety first — read before running
+
+- These examples talk to /dev/i2c-\* devices. That is literal hardware (buses and devices).
 - Scanning and writing may change device state and can harm peripherals. Do NOT run write examples against hardware you don't own/understand.
 
-Permissions and access
-----------------------
+## Permissions and access
+
 - Prefer running as an unprivileged user that belongs to the `i2c` group. If you need elevated permissions, use sudo.
 - Example device path: `/dev/i2c-1`. Adjust to your platform (e.g. `/dev/i2c-0` or other bus numbers).
 
-How to build and run
---------------------
+## How to build and run
+
 1. From the project root:
 
    ```sh
@@ -31,12 +30,12 @@ How to build and run
    - `master_reader_c` — read a register (repeated-start)
    - `master_multiplier_c` — demo request/response
 
-Quick safety checklist
----------------------
+## Quick safety checklist
+
 - Confirm the correct bus file exists (e.g., `ls /dev/i2c-*`).
 - Prefer the strict scanner if you need to avoid false positives, but be aware it performs writes.
 - Never run write examples unless you know the target device address and register behavior.
 
-Questions/Problems
------------------
+## Questions/Problems
+
 If you hit permission or device-not-found errors, check group membership, device path, and that the I2C kernel driver is loaded.

examples/cpp/README.md

@@ -1,19 +1,16 @@
-Examples — C++
-================
+# Examples — C++
+
+## Purpose
 
-Purpose
--------
 Small C++ example programs that use the TwoWire (Wire) interface provided by linux-wire.
 
-Quick safety checklist
----------------------
+## Quick safety checklist
 
 - These examples operate on `/dev/i2c-*` devices. Scanning and writes talk to real hardware.
 - Do not run write examples against unknown devices — they may change configuration or damage hardware.
 - Prefer running as a user in the `i2c` group; use sudo only when necessary.
 
-Common build/run
-----------------
+## Common build/run
 
 Build from the repo root:
 
@@ -30,7 +27,7 @@ Representative binary names (in `build/`):
 - `master_reader_cpp`
 - `master_multiplier_cpp`
 
-Notes
------
+## Notes
+
 - Use the strict scanner if you need to force a data-phase ACK (it performs a write probe).
 - Examples are tiny demos; they are not production-grade I2C tools — use with caution.