aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index e5f9620..e137cc2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,16 @@
-arcode
-======
+# Arduino hardware cores
-Arduino hardware cores \ No newline at end of file
+This is a fork of the core Arduino core hardware libraries. Currently this
+includes the [hardware/avr/core][1] and hardware/sam/core folders.
+
+The goal is to have a simple base to customize the core libraries to add or modify core functionality, without
+needing to clone the entire Arduino repository.
+
+Version 1.5.x of the Arduino IDE is required to build projects with this library.
+
+## Installation and Usage
+
+Coming soon.
+
+
+ [1]: https://github.com/arduino/Arduino/tree/ide-1.5.x/hardware/arduino/avr/cores