From f9045bea6e5bc8534d4b80ba826d4aad7dc68551 Mon Sep 17 00:00:00 2001 From: Jun Wako Date: Thu, 23 Apr 2015 17:20:59 +0900 Subject: Fix typo of doc/keycode.txt --- doc/keycode.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/keycode.txt b/doc/keycode.txt index 760c726e3b..44d7e27cd6 100644 --- a/doc/keycode.txt +++ b/doc/keycode.txt @@ -174,7 +174,7 @@ KC_CLEAR_AGAIN A2 Keyboard Clear/Again KC_CRSEL A3 Keyboard CrSel/Props KC_EXSEL A4 Keyboard ExSel /* Modifiers */ -KC_LCTRL KC_LCTRL E0 Keyboard LeftControl +KC_LCTRL KC_LCTL E0 Keyboard LeftControl KC_LSHIFT KC_LSFT E1 Keyboard LeftShift KC_LALT E2 Keyboard LeftAlt KC_LGUI E3 Keyboard Left GUI(Windows/Apple/Meta key) -- cgit v1.2.3 From 3f32b224788f9e938e41e02f6ad6fcbbec67479f Mon Sep 17 00:00:00 2001 From: Jun Wako Date: Thu, 23 Apr 2015 17:30:45 +0900 Subject: Fix URL of HID Usage Tables pdf --- doc/keymap.md | 2 +- tmk_core/doc/keymap.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/keymap.md b/doc/keymap.md index 9d986a8c51..d4a129b208 100644 --- a/doc/keymap.md +++ b/doc/keymap.md @@ -198,7 +198,7 @@ There are 8 modifiers which has discrimination between left and right. See keycode table in [`doc/keycode.txt`](./keycode.txt) for description of keycodes. In regard to implementation side most of keycodes are identical with [HID usage][HID_usage](pdf) sent to host for real and some virtual keycodes are defined to support special actions. -[HID_usage]: http://www.usb.org/developers/devclass_docs/Hut1_11.pdf +[HID_usage]: http://www.usb.org/developers/hidpage/Hut1_12v2.pdf diff --git a/tmk_core/doc/keymap.md b/tmk_core/doc/keymap.md index 9d986a8c51..d4a129b208 100644 --- a/tmk_core/doc/keymap.md +++ b/tmk_core/doc/keymap.md @@ -198,7 +198,7 @@ There are 8 modifiers which has discrimination between left and right. See keycode table in [`doc/keycode.txt`](./keycode.txt) for description of keycodes. In regard to implementation side most of keycodes are identical with [HID usage][HID_usage](pdf) sent to host for real and some virtual keycodes are defined to support special actions. -[HID_usage]: http://www.usb.org/developers/devclass_docs/Hut1_11.pdf +[HID_usage]: http://www.usb.org/developers/hidpage/Hut1_12v2.pdf -- cgit v1.2.3 From 9f1d23bfe11d0a2db028ec2d585385094b80c098 Mon Sep 17 00:00:00 2001 From: tmk Date: Sat, 12 Sep 2015 05:27:37 +0900 Subject: Add Ateml toolchain and remove specific chip name --- doc/build.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/build.md b/doc/build.md index 20702e94c9..beff191b8c 100644 --- a/doc/build.md +++ b/doc/build.md @@ -6,9 +6,9 @@ Download and Install -------------------- ### 1. Install Tools -1. **Toolchain** On Windows install [MHV AVR Tools][mhv] for AVR GCC compiler and [Cygwin][cygwin](or [MinGW][mingw]) for shell terminal. On Mac you can use [CrossPack][crosspack]. On Linux you can install AVR GCC with your favorite package manager. +1. **Toolchain** On Windows install [Atmel AVR Toolchain][atmelgcc] for AVR GCC compiler and [Cygwin][cygwin](or [MinGW][mingw]) for shell terminal. On Mac you can use [CrossPack][crosspack] or your favorite package manager. On Linux you can install AVR GCC with your favorite package manager. -2. **Programmer** On Windows install [Atmel FLIP][flip]. On Mac and Linux install [dfu-programmer][dfu-prog]. +2. **Programmer** Install [dfu-programmer][dfu-prog]. GUI tool [Atmel FLIP][flip] also can be used on Windows. 3. **Driver** On Windows you start DFU bootloader on the chip first time you will see 'Found New Hardware Wizard' to install driver. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you shall need to update its driver on 'Device Manager'. You will find the driver in `FLIP` install directory like: C:\Program Files (x86)\Atmel\Flip 3.4.5\usb\. In case of `dfu-programmer` use its driver. @@ -53,7 +53,7 @@ Now you have **hex** file to program on current directory. This **hex** is only How to program controller depends on controller chip and its board design. To program AVR USB chips you'll need to start it up in bootloader mode. Most of boards with the chip have a push button to let bootloader come up. Consult with your controller board manual. ### 2. Program with DFU bootloader -Stock AVR USB chip including ATmega32U4 has DFU bootloader by factory default. `FLIP` is a DFU programmer on Windows offered by Atmel. Open source command line tool `dfu-programmer` also supports AVR chips, it runs on Linux, Mac OSX and even Windows. +Stock AVR USB chips have DFU bootloader by factory default. `FLIP` is a DFU programmer on Windows offered by Atmel. Open source command line tool `dfu-programmer` also supports AVR chips, it runs on Linux, Mac OSX and even Windows. To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`. If you have a proper program command in `Makefile` just type this. @@ -68,7 +68,7 @@ Or to program with `dfu-programmer` run: $ make -f Makefile. dfu #### FLIP GUI tutorial -1. On menu bar click Device -> Select, then. `ATmega32u4`. +1. On menu bar click Device -> Select, then choose your chip name. 2. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog. At this point you'll see grey-outed widgets on the app get colored and ready. @@ -99,10 +99,9 @@ You may want to use other programmer like `avrdude` with AVRISPmkII, Arduino or $ make -f Makefile. program +[atmelgcc]: http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx [cygwin]: https://www.cygwin.com/ [mingw]: http://www.mingw.org/ -[mhv]: https://infernoembedded.com/products/avr-tools -[winavr]: http://winavr.sourceforge.net/ [crosspack]: http://www.obdev.at/products/crosspack/index.html [flip]: http://www.atmel.com/tools/FLIP.aspx [dfu-prog]: http://dfu-programmer.sourceforge.net/ -- cgit v1.2.3