aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKristofer Jonsson <kristofer.jonsson@arm.com>2020-04-17 08:45:38 +0200
committerKristofer Jonsson <kristofer.jonsson@arm.com>2020-04-23 13:33:34 +0200
commit1823930ea1baaaf5975dc0b03eddb45917509410 (patch)
treed69954e36a538c505bb057b41d340b6adc36f25e /README.md
parente5dd4b887537f3376db97b3ca3c2610a69e39911 (diff)
downloadethos-u-core-software-1823930ea1baaaf5975dc0b03eddb45917509410.tar.gz
MLBEDSW-1729 Adding core software build files
Change-Id: Ia4d90f2e8875f33b70aec2dd53e2128192a4e10a
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
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.