From 1e46b40a2e99e14c7a637ce6600e2c3c97442771 Mon Sep 17 00:00:00 2001 From: wolfv6 Date: Mon, 9 May 2016 15:16:28 -0600 Subject: [PATCH] document --- doc/keybrd_library_developer_guide.md | 2 ++ doc/keybrd_library_user_guide.md | 1 + 2 files changed, 3 insertions(+) diff --git a/doc/keybrd_library_developer_guide.md b/doc/keybrd_library_developer_guide.md index ccb0e83..bc4c1be 100644 --- a/doc/keybrd_library_developer_guide.md +++ b/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. + + * Code is automatically formated before being pushed to the keybrd repository The options file doc/astyle_cpp specifies the format: * Allman style indentation diff --git a/doc/keybrd_library_user_guide.md b/doc/keybrd_library_user_guide.md index 5c312d2..67e4fe3 100644 --- a/doc/keybrd_library_user_guide.md +++ b/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.