From 6f85236d16f886a51d915a1b10d7d14707461b2f Mon Sep 17 00:00:00 2001 From: Ross Burton Date: Wed, 30 Sep 2020 16:05:14 +0100 Subject: [PATCH] arm-bsp/documentation: add BSP documentation template Add a template for future BSP documentation. Change-Id: I614d43f477f1a5dfb898b808d4c5b78a5bb163b8 Signed-off-by: Ross Burton Signed-off-by: Jon Mason --- meta-arm-bsp/documentation/template.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 meta-arm-bsp/documentation/template.md diff --git a/meta-arm-bsp/documentation/template.md b/meta-arm-bsp/documentation/template.md new file mode 100644 index 00000000..7beeb595 --- /dev/null +++ b/meta-arm-bsp/documentation/template.md @@ -0,0 +1,19 @@ +# *Hardware Name* + +## Overview + +*Brief summary of the hardware* + +*Link to reference documentation* + +## Building + +*Any special steps required to build successfully beyond setting MACHINE* + +*For example: corstone700 needs DISTRO=poky-tiny, musca only supports TF-M* + +## Running + +*A summary of how to deploy or execute the image* + +*For example, an overview of the N1SDP SD structure, or FVP arguments*