g1smo
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
QMK firmware za naš dactyl https://wiki.ljudmila.org/Tipkovnica_dactyl
4,879 Commits
3 Branches
0 Tags
292 MiB
C 93.5%
C++ 4.1%
Python 1.2%
Makefile 1.1%
 
 
 
 
Go to file
Priyadi Iman Nurcahyo 93b2f23bba Promethium rev2 
* 10 more indicator LEDs
* Piezo buzzer
* Uses HC138 decoder to free up 5 pins
* Trackpoint buttons are now part of matrix
 		2017-04-19 01:38:08 +07:00
doc Fix formatting in BUILD_GUIDE.md (#1208) 2017-04-04 22:39:28 -07:00
keyboards Promethium rev2 2017-04-19 01:38:08 +07:00
lib Add Google Test submodule 2016-08-27 21:57:49 +03:00
quantum Fix buffer overrun in lcd_keyframes 2017-04-13 21:40:06 +03:00
tmk_core Add make option for allowing warnings 2017-04-13 16:12:55 +03:00
util Add freebsd support in "util/install_dependencies.sh" 2017-03-07 13:12:10 -05:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore Update readme and default layout for TADA68 2017-03-11 22:09:50 -08:00
.gitmodules Add Google Test submodule 2016-08-27 21:57:49 +03:00
.travis.yml send travis stuff to gitter 2017-02-12 12:23:03 -05:00
Dockerfile Reverted Dockerfile to put the CMD back 2017-01-31 19:59:59 -05:00
Makefile Add SKIP_VERSION option to speed up compilation 2017-04-13 16:00:29 +03:00
Vagrantfile Update some obsolete references 2016-07-30 08:37:30 +02:00
build_keyboard.mk Fix process_unicode_common.c being included twice 2017-04-13 16:03:01 +03:00
build_test.mk Disable map file creation when building tests 2016-08-27 21:57:49 +03:00
common.mk separated into api files/folder 2016-11-26 15:38:44 -05:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
message.mk Detect failures when running multiple tests 2016-08-27 21:57:49 +03:00
readme.md Update readme.md 2017-04-02 18:44:15 -06:00
testlist.mk Basic framework for parsing test targets 2016-08-27 21:57:49 +03:00

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.