aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKristofer Jonsson <kristofer.jonsson@arm.com>2020-04-30 14:18:27 +0200
committerKristofer Jonsson <kristofer.jonsson@arm.com>2020-05-05 13:00:03 +0200
commit92b84384a3c6841db5fea0cf268423e6fd252e90 (patch)
treeb62483a9226167100779e31fbcb12cfb7dc0d082 /README.md
parenta9f38d506a5c56132c065384069ccf937b2334a6 (diff)
downloadethos-u-core-driver-92b84384a3c6841db5fea0cf268423e6fd252e90.tar.gz
MLBEDSW-2054 Add README.md
Change-Id: I3cdf8f21ed58ace2f2c739748d788ec97fb4083a
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..40d079d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Ethos-u Core Driver
+
+This repository contains a device driver for the Ethos-u NPU.
+
+## Building
+
+The source code comes with a CMake based build system. The driver is expeced
+to be cross compiled for any of the supported Arm Cortex-m CPUs, which will
+require the user to setup a custom toolchain file.
+
+The user is also required to define `CMAKE_SYSTEM_PROCESSOR` for the target CPU,
+for example cortex-m55+nodsp+nofp. This can be done either in the toolchain
+file or on the command line.
+
+```
+$ mkdir build
+$ cd build
+$ cmake .. -DCMAKE_TOOLCHAIN_FILE=<toolchain> -DCMAKE_SYSTEM_PROCESSOR=cortex-m<nr><features>
+$ make
+```