di0ib/keybrd
Archived
1
0
Fork 0
Code Releases Activity

document

Browse Source
This commit is contained in:
wolfv6 2016-05-09 15:14:09 -06:00
parent d5e7405293
commit 3ea73dfa0b
2 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/keybrd_library_developer_guide.md
View File

@ -136,7 +136,7 @@ Following the style guide makes it easier for the next programmer to understand
* Code should be self-documenting.
The only comments should be things that may need clarification.
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
The options file doc/astyle_cpp specifies the format:
* Allman style indentation

3
doc/keybrd_library_user_guide.md
View File

@ -12,7 +12,7 @@ The Arduino development environment is free and simple as possible.
Its easy for novice programmers to setup and learn.
## 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.
An experienced C++ programmer would be able to write original sketches and classes.
@ -121,7 +121,6 @@ If it isn't already plugged in, plug the USB cable into the computer and control
> if that fails, unplug Teensy USB
Compile and load workflow:
1. Open a keybrd sketch in the Arduino IDE.
2. Prepare for loosing control of keyboard and mouse.
3. On the Arduino IDE, click the Upload button.