X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=README.md;h=4a6d80fbfc260b22c9536b00d8c66b498ce561b4;hb=803b65ea43b6b27d5c43af1705a7cbc87c87946b;hp=78817a84f95825bb19ab962d74348495f98c9f6a;hpb=799993c414416c8b23acfaf8f2701ea514d10080;p=max%2Ftmk_keyboard.git diff --git a/README.md b/README.md index 78817a84..4a6d80fb 100644 --- a/README.md +++ b/README.md @@ -107,19 +107,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 +128,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 +199,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 +226,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 +241,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-Protjects) other than TMK.