Halaman utama Jelajahi Bantuan
Daftar Masuk
HuiJun
/
qmk_firmware
1
0
Fork 0
Berkas Masalah 0 Permintaan Tarik 0 Wiki

Tidak Ada Deskripsi

Pohon: cb60fe393f
Ranting Tag
qmk_firmware
ZIP TAR.GZ
Daniel Shields cb60fe393f Add new keymap for dshields. 8 tahun lalu
doc 154305ce1b Fix formatting in BUILD_GUIDE.md (#1208) 8 tahun lalu
keyboards cb60fe393f Add new keymap for dshields. 8 tahun lalu
lib cfddec17d5 Add Google Test submodule 8 tahun lalu
quantum 436d661775 dynamic_macro.h: Fix an off-by-two error 8 tahun lalu
tmk_core 18b4d24cc3 Add possibility to override the command to execute when flashing 8 tahun lalu
util a9959783c0 Add freebsd support in "util/install_dependencies.sh" 8 tahun lalu
.gitattributes de58ec9738 Set eep files to binary mode 8 tahun lalu
.gitignore 96bde794d8 Update readme and default layout for TADA68 8 tahun lalu
.gitmodules cfddec17d5 Add Google Test submodule 8 tahun lalu
.travis.yml a773124537 send travis stuff to gitter 8 tahun lalu
Dockerfile 7ce94eb468 Cleaning Up Dockerfile Layers Per Official Docs 8 tahun lalu
Makefile 738b8d2b9c Add SKIP_VERSION option to speed up compilation 8 tahun lalu
Vagrantfile 8a9bf1f165 Update some obsolete references 9 tahun lalu
build_keyboard.mk d8e2ff2964 Fix process_unicode_common.c being included twice 8 tahun lalu
build_test.mk 42baa6cf43 Disable map file creation when building tests 8 tahun lalu
common.mk 7edac212c8 separated into api files/folder 8 tahun lalu
license_GPLv2.md 23839b8c6d Clarify the quantum license (#1042) 8 tahun lalu
license_GPLv3.md 23839b8c6d Clarify the quantum license (#1042) 8 tahun lalu
license_Modified_BSD.md 23839b8c6d Clarify the quantum license (#1042) 8 tahun lalu
message.mk 7eefb34e7c Detect failures when running multiple tests 8 tahun lalu
readme.md 570b4605b2 Update readme.md 8 tahun lalu
testlist.mk 6d7cd639a5 Basic framework for parsing test targets 8 tahun lalu

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, 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/quantum_keycodes.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 quantum_keycodes.h is where they're actually defined.
  • The TMK documentation. QMK is based on TMK, and this explains how it works internally.