aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..480477a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Arm Ethos-U core platform
+
+*Arm Ethos-U core platform* is provided as an example of how to produce a
+firmware binary for a given target platform. This software is primarily intended
+for guidance, to demonstrate how to boot up a firmware binary and how to run an
+inference on an Arm Ethos-U compatible platform.
+
+This repository contains target specific files, like linker scripts. Target
+agnostic software components are provided in the
+[core_software](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-core-software)
+repository.
+
+# License
+
+The Arm Ethos-U Core Platform is provided 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 \<john.doe@example.org\>
+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
+
+Please see [Security](SECURITY.md).