di0ib
/
keybrd
Watch 1
Star 0
Fork 0
Code Releases 7 Activity
Browse Source

document

tags/v0.5.0
wolfv6 8 years ago
parent
d5e7405293
commit
3ea73dfa0b
2 changed files with 2 additions and 3 deletions
Unified View Show Diff Stats
  1. 1
    1
      doc/keybrd_library_developer_guide.md
  2. 1
    2
      doc/keybrd_library_user_guide.md

+ 1
- 1
doc/keybrd_library_developer_guide.md View File

* Code should be self-documenting. * Code should be self-documenting.
The only comments should be things that may need clarification. The only comments should be things that may need clarification.
A simple function with a good name needs no comment. A simple function with a good name needs no comment.
<--! http://stackoverflow.com/questions/2198241/best-practice-for-c-function-commenting -->
<!-- http://stackoverflow.com/questions/2198241/best-practice-for-c-function-commenting -->
* Code is automatically formated before being pushed to the keybrd repository * Code is automatically formated before being pushed to the keybrd repository
The options file doc/astyle_cpp specifies the format: The options file doc/astyle_cpp specifies the format:
* Allman style indentation * Allman style indentation

+ 1
- 2
doc/keybrd_library_user_guide.md View File

Its easy for novice programmers to setup and learn. Its easy for novice programmers to setup and learn.
## Who this guide is for ## Who this guide is for
This guide is for anyone who wants to use the keybrd library to develop custom-keyboard firmware.
This guide is for anyone who wants to use the keybrd library to develop keyboard firmware.
A reader with programming experience, but no C++ experience, would understand the tutorials well enough to modify existing keybrd sketches. A reader with programming experience, but no C++ experience, would understand the tutorials well enough to modify existing keybrd sketches.
An experienced C++ programmer would be able to write original sketches and classes. An experienced C++ programmer would be able to write original sketches and classes.
> if that fails, unplug Teensy USB > if that fails, unplug Teensy USB
Compile and load workflow: Compile and load workflow:
1. Open a keybrd sketch in the Arduino IDE. 1. Open a keybrd sketch in the Arduino IDE.
2. Prepare for loosing control of keyboard and mouse. 2. Prepare for loosing control of keyboard and mouse.
3. On the Arduino IDE, click the Upload button. 3. On the Arduino IDE, click the Upload button.