Merge pull request #19 from mmarchetti/library-spec

Library spec
mmarchetti · Mar 7, 2019 · 261fa80 · 261fa80
2 parents a33f900 + 966d48d
commit 261fa80
Show file tree

Hide file tree

Showing 19 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ The standard Arduino I/O library (Wiring) isn't particularly fast. There are sev
 | Max Output Frequency | 64 KHz                     | 2.66 MHz                  |
 | RAM usage            | none                       | none                      |
 
-[Benchmarks](docs/avr_benchmarks.md)
+[Benchmarks](extras/docs/avr_benchmarks.md)
 
 #### SAM boards (Due)
 
@@ -60,7 +60,7 @@ The standard Arduino I/O library (Wiring) isn't particularly fast. There are sev
 | Max Output Frequency | 237 KHz                     | 10.5 MHz                 |
 | RAM usage            | none                        | none                     |
 
-[Benchmarks](docs/arm_benchmarks.md)
+[Benchmarks](extras/docs/arm_benchmarks.md)
 
 ### API
 

diff --git a/docs/arm_benchmarks.md → extras/docs/arm_benchmarks.md b/docs/arm_benchmarks.md → extras/docs/arm_benchmarks.md
diff --git a/docs/avr_benchmarks.md → extras/docs/avr_benchmarks.md b/docs/avr_benchmarks.md → extras/docs/avr_benchmarks.md
diff --git a/docs/boards_todo → extras/docs/boards_todo b/docs/boards_todo → extras/docs/boards_todo
diff --git a/docs/images/direct.png → extras/docs/images/direct.png b/docs/images/direct.png → extras/docs/images/direct.png
diff --git a/docs/images/direct_pin.png → extras/docs/images/direct_pin.png b/docs/images/direct_pin.png → extras/docs/images/direct_pin.png
diff --git a/docs/images/direct_port.png → extras/docs/images/direct_port.png b/docs/images/direct_port.png → extras/docs/images/direct_port.png
diff --git a/docs/images/direct_port2.png → extras/docs/images/direct_port2.png b/docs/images/direct_port2.png → extras/docs/images/direct_port2.png
diff --git a/docs/images/due_direct.png → extras/docs/images/due_direct.png b/docs/images/due_direct.png → extras/docs/images/due_direct.png
diff --git a/docs/images/due_direct_full_port.png → extras/docs/images/due_direct_full_port.png b/docs/images/due_direct_full_port.png → extras/docs/images/due_direct_full_port.png
diff --git a/docs/images/due_direct_port.png → extras/docs/images/due_direct_port.png b/docs/images/due_direct_port.png → extras/docs/images/due_direct_port.png
diff --git a/docs/images/due_normal.png → extras/docs/images/due_normal.png b/docs/images/due_normal.png → extras/docs/images/due_normal.png
diff --git a/docs/images/due_normal_port.png → extras/docs/images/due_normal_port.png b/docs/images/due_normal_port.png → extras/docs/images/due_normal_port.png
diff --git a/docs/images/normal.png → extras/docs/images/normal.png b/docs/images/normal.png → extras/docs/images/normal.png
diff --git a/docs/images/normal_port.png → extras/docs/images/normal_port.png b/docs/images/normal_port.png → extras/docs/images/normal_port.png
diff --git a/docs/images/samd_direct.png → extras/docs/images/samd_direct.png b/docs/images/samd_direct.png → extras/docs/images/samd_direct.png
diff --git a/docs/images/samd_normal.png → extras/docs/images/samd_normal.png b/docs/images/samd_normal.png → extras/docs/images/samd_normal.png
diff --git a/tools/gen_pins.py → extras/tools/gen_pins.py b/tools/gen_pins.py → extras/tools/gen_pins.py
diff --git a/library.properties b/library.properties
@@ -0,0 +1,10 @@
+name=DirectIO
+version=1.2.0
+author=Michael Marchetti <[email protected]>
+maintainer=Michael Marchetti <[email protected]>
+sentence=DirectIO is a fast, simple I/O library for AVR, SAM, and SAMD boards.
+paragraph=It provides a simple API for doing digital I/O 40-60x faster than the Arduino standard libraries. You can read or write a digital pin in a sinle clock cycle on an AVR-based board. Accelerated support is available for AVR, SAM, and SAMD boards. Other boards are supported in a fallback mode without acceleration.
+category=Signal Input/Output
+url=https://github.com/mmarchetti/DirectIO
+architectures=avr,sam,samd
+includes=DirectIO.h