diff --git a/README.md b/README.md index 439d7e6..8ba1239 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ keybrd library for creating keyboard firmware ============================================= keybrd library is an open source library for creating custom-keyboard firmware. The keybrd library allows keyboard designers to develop and publish their firmware simply as possible. -The resulting keyboard firmware is compatible with standard USB keyboard drivers. keybrd library can support any keyboard configuration: * one-piece @@ -19,6 +18,7 @@ keybrd library leverages the Arduino environment to create keyboard firmware. The Arduino development environment is free, and easy for novice programmers to setup and learn. The keybrd library has been tested on Teensy LC, Teensy 2.0, 74HC165 shift registers, and PCA9655E I/O expander. +The resulting keyboard firmware is compatible with standard USB keyboard drivers. > The keybrd library is in Beta testing. The public API should not be considered stable. @@ -51,7 +51,7 @@ Support ------- [Guides](doc) and [tutorials](tutorials) are provided. -keybrd tutorial_1 shows how to make a breadboard keyboard. +keybrd tutorial_1 shows how to build a breadboard keyboard. The remaining [keybrd tutorials](tutorials) show how to create custom keybrd firmware. Please ask questions in [keybrd library for keyboard firmware](geekhack todo) thread if something is not clear. diff --git a/doc/keybrd_library_developer_guide.md b/doc/keybrd_library_developer_guide.md index f521862..9bf7346 100644 --- a/doc/keybrd_library_developer_guide.md +++ b/doc/keybrd_library_developer_guide.md @@ -274,4 +274,4 @@ The keybrd libraries compile on the Arduino IDE and make extensive use of the fo #include #include -Creative Commons License
keybrd guide by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd guide by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/doc/keybrd_library_user_guide.md b/doc/keybrd_library_user_guide.md index 084adce..c012dd1 100644 --- a/doc/keybrd_library_user_guide.md +++ b/doc/keybrd_library_user_guide.md @@ -228,4 +228,4 @@ By themselves, modifier keys usually do nothing; that is, pressing any of the Sh **keybrd sketch** - is an Arduino sketch that uses the keybrd library to define a keyboard firmware. -Creative Commons License
keybrd guide by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd guide by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_0_introduction.md b/tutorials/tutorial_0_introduction.md index 9f714bd..83ed1b3 100644 --- a/tutorials/tutorial_0_introduction.md +++ b/tutorials/tutorial_0_introduction.md @@ -13,4 +13,4 @@ The tutorials assume the reader: * is new to Arduino, firmware, controllers, and the internal workings of keyboards
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_10_writing_your_own_port_classes.md b/tutorials/tutorial_10_writing_your_own_port_classes.md index 28b7c7c..71824fc 100644 --- a/tutorials/tutorial_10_writing_your_own_port_classes.md +++ b/tutorials/tutorial_10_writing_your_own_port_classes.md @@ -15,4 +15,4 @@ Debugging I/O expander code is hard because SPI or I2C protocol adds a level of If you haven't written Arduino code for an I/O expander before, learn from an Arduiono I/O expander tutorial before attempting it here.
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_1_breadboard_keyboard.md b/tutorials/tutorial_1_breadboard_keyboard.md index 91d36ae..8a0f8d7 100644 --- a/tutorials/tutorial_1_breadboard_keyboard.md +++ b/tutorials/tutorial_1_breadboard_keyboard.md @@ -132,4 +132,4 @@ Exercises 1) replace the diodes with wires (cutoffs) and intentionally cause ghosting.
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_2_single-layer_keyboard.md b/tutorials/tutorial_2_single-layer_keyboard.md index 15c9e2f..a742203 100644 --- a/tutorials/tutorial_2_single-layer_keyboard.md +++ b/tutorials/tutorial_2_single-layer_keyboard.md @@ -16,4 +16,4 @@ The classes are defined in the [keybrd library](../src/). 2) Add a third column to the breadboard keyboard and sketch.
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_3a_multi-layer_keyboard.md b/tutorials/tutorial_3a_multi-layer_keyboard.md index 8c6c71a..23922ea 100644 --- a/tutorials/tutorial_3a_multi-layer_keyboard.md +++ b/tutorials/tutorial_3a_multi-layer_keyboard.md @@ -133,5 +133,5 @@ Exercises | **1** | layer0 | layer1 |
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_3b_autoShift.md b/tutorials/tutorial_3b_autoShift.md index b659ae5..9d653b5 100644 --- a/tutorials/tutorial_3b_autoShift.md +++ b/tutorials/tutorial_3b_autoShift.md @@ -26,4 +26,4 @@ Exercises | **1** |. sym .|. num .|
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_5_LEDs.md b/tutorials/tutorial_5_LEDs.md index 51ea77f..85c1dcb 100644 --- a/tutorials/tutorial_5_LEDs.md +++ b/tutorials/tutorial_5_LEDs.md @@ -91,4 +91,4 @@ Calculate the minimum resistance needed for your LED and Supply Voltage. There are several "LED current limiting resistor calculators" on line.
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_6_active_high.md b/tutorials/tutorial_6_active_high.md index e8bd508..4d5c4e9 100644 --- a/tutorials/tutorial_6_active_high.md +++ b/tutorials/tutorial_6_active_high.md @@ -78,4 +78,4 @@ The [keybrd_6_active_highsketch.ino](keybrd_6_active_high/keybrd_6_active_high.i ![pull_down_resistors.JPG](keybrd_6_active_high/pull_down_resistors.JPG "Active-high diodes and pull-down resistors")
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_8a_using_someone_else's_keybrd_extension_library.md b/tutorials/tutorial_8a_using_someone_else's_keybrd_extension_library.md index 6d02063..ac3813c 100644 --- a/tutorials/tutorial_8a_using_someone_else's_keybrd_extension_library.md +++ b/tutorials/tutorial_8a_using_someone_else's_keybrd_extension_library.md @@ -13,4 +13,4 @@ Instructions for installing a library on Arduino IDE are at: Once a keybrd extension library is installed, it's classes can be included in your sketch.
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_8b_creating_and_publishing_your_own_keybrd_extension_library.md b/tutorials/tutorial_8b_creating_and_publishing_your_own_keybrd_extension_library.md index a98b7fa..c35b4a3 100644 --- a/tutorials/tutorial_8b_creating_and_publishing_your_own_keybrd_extension_library.md +++ b/tutorials/tutorial_8b_creating_and_publishing_your_own_keybrd_extension_library.md @@ -73,7 +73,7 @@ Example library.properties file: sentence=An extension to the keybrd library for the MyKeyboard. paragraph=This library demonstrates my feature. category=Device Control - url=https://github.com/Me/keybrd_MyKeyboard + url= (github repo URL for keybrd_MyKeyboard) architectures=* ``` @@ -86,4 +86,4 @@ Sign in at http://playground.arduino.cc/Main/LibraryList and add keybrd librarie http://playground.arduino.cc/Main/InterfacingWithHardware#keyb
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. diff --git a/tutorials/tutorial_9_breaking_up_a_sketch_into_smaller_files.md b/tutorials/tutorial_9_breaking_up_a_sketch_into_smaller_files.md index 447825a..7236d79 100644 --- a/tutorials/tutorial_9_breaking_up_a_sketch_into_smaller_files.md +++ b/tutorials/tutorial_9_breaking_up_a_sketch_into_smaller_files.md @@ -28,4 +28,4 @@ So you publish your keybrd extension library with two versions of instantiations * instantiations_matrix_QWERTY.h
-Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new. +Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new.