From 3ea73dfa0b9e9554219661ef2d5aefa40e04ca55 Mon Sep 17 00:00:00 2001 From: wolfv6 Date: Mon, 9 May 2016 15:14:09 -0600 Subject: [PATCH] document --- doc/keybrd_library_developer_guide.md | 2 +- doc/keybrd_library_user_guide.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/keybrd_library_developer_guide.md b/doc/keybrd_library_developer_guide.md index 34dcf7d..ccb0e83 100644 --- a/doc/keybrd_library_developer_guide.md +++ b/doc/keybrd_library_developer_guide.md @@ -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 --> + * 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 5a5b18f..5c312d2 100644 --- a/doc/keybrd_library_user_guide.md +++ b/doc/keybrd_library_user_guide.md @@ -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.