X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=README.md;h=7edce6073f97352ef16cc4e2fff4b29e01cd63f2;hb=d4982a21ac8f3ba003da41ceb581bffb4e78fefa;hp=78817a84f95825bb19ab962d74348495f98c9f6a;hpb=799993c414416c8b23acfaf8f2701ea514d10080;p=max%2Ftmk_keyboard.git diff --git a/README.md b/README.md index 78817a84..7edce607 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ Source code is available here: Updates ------- +#### 2016/02/10 +core: flabbergast's Chibios protocol was merged from (@72b1668). See [tmk_core/protocol/chibios/README.md](tmk_core/protocol/chibios/README.md). Chibios protocol supports Cortex-M such as STM32 and Kinetis. + #### 2015/04/22 Core library was separated to other branch `core`. @@ -71,7 +74,7 @@ You can find some keyboard specific projects under `converter` and `keyboard` di * [Lightpad](keyboard/lightpad) - Korean custom keypad * [ghost_squid](keyboard/ghost_squid/) - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt] -### Extenal projects using tmk_keyboard +### External projects using tmk_keyboard * [ErgoDox_cub-uanic][cub-uanic] - Split Ergonomic Keyboard [ErgoDox][ergodox_org] * [mcdox][mcdox_tmk] - [mcdox][mcdox] @@ -107,19 +110,20 @@ You can find some keyboard specific projects under `converter` and `keyboard` di License ------- **GPLv2** or later. Some protocol files are under **Modified BSD License**. -LUFA, PJRC and V-USB stack have their own license respectively. + +Third party libraries like LUFA, PJRC and V-USB have their own license respectively. Build Firmware and Program Controller ------------------------------------- -See [doc/build.md](doc/build.md). +See [tmk_core/doc/build.md](tmk_core/doc/build.md). Change your keymap ------------------ -See [doc/keymap.md](doc/keymap.md). +See [tmk_core/doc/keymap.md](tmk_core/doc/keymap.md). @@ -127,7 +131,8 @@ Magic Commands -------------- To see help press `Magic` + `H`. - `Magic` key bind may be `LShift` + `RShift` in many project, but `Power` key on ADB converter. `Magic` keybind can be vary on each project, check `config.h` in project directory. +`Magic` key combination is `LShift` + `RShift` in many project, but `Power` key on ADB converter. +`Magic` keybind can be vary on each project, check `config.h` in project directory. Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed. @@ -197,7 +202,10 @@ To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be Mechanical Locking support -------------------------- -This feature makes it possible for you to use mechanical switch for `CapsLock`, `NumLock` or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LNUM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Resync option tries to keep lock switch state consistent with keyboard LED state. +This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock` +or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LN +UM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Res +ync option tries to keep switch state consistent with keyboard LED state. #define LOCKING_SUPPORT_ENABLE #define LOCKING_RESYNC_ENABLE @@ -221,10 +229,10 @@ You can use xprintf() to display debug info on `hid_listen`, see `tmk_core/commo Files and Directories ------------------- ### Top -* tmk_core/ - core library * keyboard/ - keyboard projects * converter/ - protocol converter projects -* doc/ - documents +* tmk_core/ - core library +* tmk_core/doc/ - documents @@ -236,4 +244,4 @@ Coding Style Other Keyboard Firmware Projects ------------------ -You can learn a lot about keyboard firmware from these. See [doc/other_projects.md](doc/other_projects.md). +You can learn a lot about keyboard firmware from these. See [Other Projects](https://github.com/tmk/tmk_keyboard/wiki/Other-Projects) other than TMK.