Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
mindtravel
/
qmk_firmware_custom
forknuté z logic855/qmk_firmware
2
0
Fork 0
Súbory

Žiadny popis

Strom: d96175937b
Branche Tagy
qmk_firmware...
Priyadi Iman Nurcahyo d96175937b Bug fix & added default_layer_state_set_kb 8 rokov pred
doc c9ca368008 replace jackhumbert with qmk 9 rokov pred
keyboards 4010360912 adds planck/rev3 makefile so subproject is found 8 rokov pred
lib cfddec17d5 Add Google Test submodule 9 rokov pred
quantum 3f0b491fc0 Merge pull request #1082 from priyadi/right-side-dual-function 8 rokov pred
tmk_core d96175937b Bug fix & added default_layer_state_set_kb 8 rokov pred
util bfc33a56d7 don't try to build the readme 8 rokov pred
.gitattributes de58ec9738 Set eep files to binary mode 9 rokov pred
.gitignore 53a2bf9215 added dvorak programmer layout 9 rokov pred
.gitmodules cfddec17d5 Add Google Test submodule 9 rokov pred
.travis.yml a773124537 send travis stuff to gitter 8 rokov pred
Dockerfile 407f949e4b Reverted Dockerfile to put the CMD back 8 rokov pred
Makefile f787f4291a Typo fixes 8 rokov pred
Vagrantfile 8a9bf1f165 Update some obsolete references 9 rokov pred
build_keyboard.mk 4348fb54d6 Merge pull request #960 from ofples/feature/combos 8 rokov pred
build_test.mk 42baa6cf43 Disable map file creation when building tests 9 rokov pred
common.mk 7edac212c8 separated into api files/folder 9 rokov pred
message.mk 7eefb34e7c Detect failures when running multiple tests 9 rokov pred
readme.md 1e97f77278 update travis badge 8 rokov pred
testlist.mk 6d7cd639a5 Basic framework for parsing test targets 9 rokov pred

readme.md

Quantum Mechanical Keyboard Firmware

Build Status Gitter

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Official website (currently under construction with the move to the wiki)

For an easy-to-read version of this document and the repository, check out http://qmk.fm. Nicely formatted keyboard and keymap listings are also available there, along with the ability to download .hex files instead of having to setup a build environment and compile them.

Included Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. This repo used to be a fork of TMK, and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons - it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK and Hasu :)

This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please open an issue.

The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by Erez Zukerman, and the Clueboard by Zach White.

Documentation roadmap

This is not a tiny project. While this is the main readme, there are many other files you might want to consult. Here are some points of interest:

  • The Wiki - the entirety of the readme has been moved here
  • The readme for your own keyboard: This is found under keyboards/<your keyboards's name>/. So for the ErgoDox EZ, it's here; for the Planck, it's here and so on.
  • The list of possible keycodes you can use in your keymap is actually spread out in a few different places:
    • doc/keycode.txt - an explanation of those same keycodes.
    • quantum/keymap.h - this is where the QMK-specific aliases are all set up. Things like the Hyper and Meh key, the Leader key, and all of the other QMK innovations. These are also explained and documented below, but keymap.h is where they're actually defined.
  • The TMK documentation. QMK is based on TMK, and this explains how it works internally.