From 92b84384a3c6841db5fea0cf268423e6fd252e90 Mon Sep 17 00:00:00 2001
From: Kristofer Jonsson <kristofer.jonsson@arm.com>
Date: Thu, 30 Apr 2020 14:18:27 +0200
Subject: MLBEDSW-2054 Add README.md

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

(limited to 'README.md')

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
+```
-- 
cgit v1.2.1