瀏覽代碼

document

tags/v0.5.0
wolfv6 8 年之前
父節點
當前提交
1e46b40a2e
共有 2 個文件被更改,包括 3 次插入0 次删除
  1. 2
    0
      doc/keybrd_library_developer_guide.md
  2. 1
    0
      doc/keybrd_library_user_guide.md

+ 2
- 0
doc/keybrd_library_developer_guide.md 查看文件

@@ -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
- 0
doc/keybrd_library_user_guide.md 查看文件

@@ -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.