From ea1f593c78983298cfcd5d13324d2f6fc063e591 Mon Sep 17 00:00:00 2001 From: Kristofer Jonsson Date: Mon, 31 Aug 2020 19:15:29 +0200 Subject: Update README.md Add information how to contribute and how to report security incidents. Change-Id: I7946e66b30c4e338ffa5a279b5d769a764c34f0f --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 47 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 40d079d..de3f314 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Ethos-u Core Driver +# Arm Ethos-U Core Driver -This repository contains a device driver for the Ethos-u NPU. +This repository contains a device driver for the Arm Ethos-U NPU. ## Building @@ -18,3 +18,48 @@ $ cd build $ cmake .. -DCMAKE_TOOLCHAIN_FILE= -DCMAKE_SYSTEM_PROCESSOR=cortex-m $ make ``` + +# License + +The Arm Ethos-U core driver is proved under an Apache-2.0 license. Please see +[LICENSE.txt](LICENSE.txt) for more information. + +# Contributions + +The Arm Ethos-U project welcomes contributions under the Apache-2.0 license. + +Before we can accept your contribution, you need to certify its origin and give +us your permission. For this process we use the Developer Certificate of Origin +(DCO) V1.1 (https://developercertificate.org). + +To indicate that you agree to the terms of the DCO, you "sign off" your +contribution by adding a line with your name and e-mail address to every git +commit message. You must use your real name, no pseudonyms or anonymous +contributions are accepted. If there are more than one contributor, everyone +adds their name and e-mail to the commit message. + +``` +Author: John Doe \ +Date: Mon Feb 29 12:12:12 2016 +0000 + +Title of the commit + +Short description of the change. + +Signed-off-by: John Doe john.doe@example.org +Signed-off-by: Foo Bar foo.bar@example.org +``` + +The contributions will be code reviewed by Arm before they can be accepted into +the repository. + +# Security + +If you believe you have identified a security related issue or vulnerability, +then we encourage you to responsibly disclose it to us as soon as possible. + +## Reporting Security Issues and Vulnerabilities + +Please send an email to with the subject +`Ethos-U Security`. In the body of the email include as much information as +possible about the issue or vulnerability and any additional contact details. -- cgit v1.2.1