From 1823930ea1baaaf5975dc0b03eddb45917509410 Mon Sep 17 00:00:00 2001
From: Kristofer Jonsson <kristofer.jonsson@arm.com>
Date: Fri, 17 Apr 2020 08:45:38 +0200
Subject: MLBEDSW-1729 Adding core software build files

Change-Id: Ia4d90f2e8875f33b70aec2dd53e2128192a4e10a
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9ccbb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Ethos-U core software
+
+## Building
+
+The core software is built with CMake. It is recommended to build out of tree like illustrated below.
+
+```
+$ mkdir build
+$ cd build
+$ cmake .. -DCMAKE_TOOLCHAIN_FILE=<toolchain> -DCMAKE_SYSTEM_PROCESSOR=cortex-m<nr><features>
+$ make
+```
+
+Available build options can be listed with `cmake -LH ..`.
+
+Supported CPU targets are any of the Cortex-M processors with any of the supported features, for example cortex-m33+nodsp+nofp. A toolchain file is required to cross compile the software.
-- 
cgit v1.2.1