Add more docs to README files

Author: thejpster

cortex-a-rt/README.md

@@ -1,4 +1,11 @@
-# Arm Cortex-A Run-Time
+# Run-time support for Arm Cortex-A (AArch32)
+
+This library implements a simple Arm vector table, suitable for getting into a
+Rust application running in System Mode. It also provides a reference start
+up method. Most Cortex-A based systems will require chip specific start-up
+code, so the start-up method can over overriden.
+
+See <https://docs.rs/cortex-a-rt> for detailed documentation.
 
 ## Features
 

cortex-r-rt/README.md

@@ -1,4 +1,11 @@
-# Arm Cortex-R Run-Time
+# Run-time support for Arm Cortex-R (AArch32)
+
+This library implements a simple Arm vector table, suitable for getting into a
+Rust application running in System Mode. It also provides a reference start
+up method. Most Cortex-R based systems will require chip specific start-up
+code, so the start-up method can over overriden.
+
+See <https://docs.rs/cortex-r-rt> for detailed documentation.
 
 ## Minimum Supported Rust Version (MSRV)
 

examples/mps3-an536/README.md

@@ -1,4 +1,18 @@
-# Examples for Arm Cortex-R
+# Examples for Arm MPS3-AN536
+
+This package contains example binaries for the Arm MPS3-AN536 evaluation
+system, featuring one or two Arm Cortex-R52 processor cores. This crate
+should be compiled for the `armv8r-none-eabihf` target. The repo-level
+[`.cargo/config.toml`] will ensure the code runs on the appropriate QEMU
+configuration.
+
+As of Rust 1.87, `armv8r-none-eabihf` is a Tier 3 target and so these examples
+require Nightly Rust.
+
+We have only tested this crate on `qemu-system-arm` emulating the Arm
+MPS3-AN536, not the real thing.
+
+[`.cargo/config.toml`]: ../../.cargo/config.toml
 
 ## Minimum Supported Rust Version (MSRV)
 

examples/versatileab/README.md

@@ -1,4 +1,16 @@
-# Examples for Arm Cortex-R
+# Examples for Arm Versatile Application Board
+
+This package contains example binaries for the Arm Versatile Application
+baseboard evaluation system, featuring an Arm Cortex-R5 processor or Arm
+Cortex-A8 processor core. This crate should be compiled for the
+`armv7r-none-eabihf`, `armv7r-none-eabi`, `armv7a-none-eabi` or
+`armv7a-none-eabihf` targets. The repo-level [`.cargo/config.toml`] will
+ensure the code runs on the appropriate QEMU configuration.
+
+We have only tested this crate on `qemu-system-arm` emulating the Arm
+Versatile Application Board, not the real thing.
+
+[`.cargo/config.toml`]: ../../.cargo/config.toml
 
 ## Minimum Supported Rust Version (MSRV)