di0ib/keybrd
Archived
1
0
Fork 0
Code Releases Activity

document

Browse Source
This commit is contained in:
wolfv6 2016-05-09 15:16:28 -06:00
parent 3ea73dfa0b
commit 1e46b40a2e
2 changed files with 3 additions and 0 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,9 @@ 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 -->
* Code is automatically formated before being pushed to the keybrd repository
The options file doc/astyle_cpp specifies the format:
* Allman style indentation

1
doc/keybrd_library_user_guide.md
View File

@ -121,6 +121,7 @@ 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.