diff --git a/README.md b/README.md index e6feeb4..e9dda35 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Example minimal keybrd sketch A [minimal keybrd sketch](tutorials/keybrd_2_single-layer_annotated/keybrd_2_single-layer_annotated.ino). has about 50 lines of code and runs on a 4-key keyboard. -It runs on a breadboard with rows, columns, and diodes just like the big keyboards. +It runs on a breadboard and has rows, columns, and diodes just like the big keyboards. The sketch is small because the keybrd library takes care of the low-level details. The keybrd tutorial 1 shows how to make a breadboard keyboard. @@ -38,11 +38,11 @@ The keybrd_DH emulates the DataHand keyboard. It has 72 keys, 4 layers, a sub-layer, 2 matrices, and many features. The keybrd_DH and its instantiation files contain about 800 lines of code. -[mainSketch.ino](https://github.com/wolfv6/keybrd_DH/blob/master/examples/keybrd_DH/mainSketch.cpp)
-[instantiations_ports.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_ports.h)
-[instantiations_LEDs.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_LEDs.h)
-[instantiations_codes.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_codes.h)
-[instantiations_matrix.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_matrix.h) + [mainSketch.ino](https://github.com/wolfv6/keybrd_DH/blob/master/examples/keybrd_DH/mainSketch.cpp)
+ [instantiations_ports.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_ports.h)
+ [instantiations_LEDs.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_LEDs.h)
+ [instantiations_codes.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_codes.h)
+ [instantiations_matrix.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_matrix.h) Support ------- diff --git a/doc/keybrd_library_user_guide.md b/doc/keybrd_library_user_guide.md index 2b24692..f5afd38 100644 --- a/doc/keybrd_library_user_guide.md +++ b/doc/keybrd_library_user_guide.md @@ -68,8 +68,8 @@ For Linux: <--! todo update after testing Arduino library manager link from tutorial 7 ## Publishing https://www.arduino.cc/en/Guide/Libraries - > Installing Additional Arduino Libraries - > Using the Library Manager + * Installing Additional Arduino Libraries + * Using the Library Manager --> Down load keybrd-master.zip from the [Download ZIP](https://github.com/wolfv6/keybrd) button. @@ -133,7 +133,7 @@ Extension libraries have their example sketches similarly located. The example sketch names use the following conventions. - **keybrd_extension_feature_version.ino** + **keybrd_extension_feature_version.ino** where * **keybrd_extension** is the extension library name e.g. keybrd_DH @@ -146,7 +146,7 @@ The first two fields are mandatory, the remaining fields are optional. The physical martix rows and columns on a keyboard can be in any direction or shape. [diode](https://en.wikipedia.org/wiki/Diode) orientation is specified in [Matrix.h](https://github.com/wolfv6/keybrd/blob/master/src/Matrix.h) -[Diode](../tutorials/images/120px-Diode_pinout_en_fr.svg.png) +[Diode](https://github.com/wolfv6/keybrd/blob/master/tutorials/images/120px-Diode_pinout_en_fr.svg.png) Diagram is of typical through-the-hole diode in same alignment as diode symbol. Cross bar and band depict the cathode.