Page Index - danielschranz/qmk_firmware GitHub Wiki
117 page(s) in this GitHub Wiki:
- Home
- Getting started
- Build Environment Setup
- Windows 10
- Windows (Vista and later)
- Mac
- Linux
- Docker
- Vagrant
- Verify Your Installation
- Customizing your keymap
- The make command
- Simple instructions for building and uploading a keyboard
- More detailed make instruction
- The Makefile
- Makefile options
- Customizing Makefile options on a per-keymap basis
- The config.h file
- Going beyond the keycodes
- Quick aliases to common actions
- Switching and toggling layers
- Fun with modifier keys
- Space Cadet Shift: The future, built in
- The Leader key: A new kind of modifier
- Tap Dance: A single key can do 3, 5, or 100 different things
- Examples
- Temporarily setting the default layer
- Prevent stuck modifiers
- Macro shortcuts: Send a whole string when pressing just one key
- Advanced macro functions
- Naming your macros
- Timer functionality
- Example: Single-key copy/paste (hold to copy, tap to paste)
- Dynamic macros: record and replay macros in runtime
- Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
- Additional language support
- Unicode support
- UNICODE_ENABLE
- UNICODEMAP_ENABLE
- UCIS_ENABLE
- Backlight Breathing
- Other firmware shortcut keycodes
- Custom Quantum functions
- void matrix_init_*(void)
- void matrix_scan_*(void)
- bool process_record_*(uint16_t keycode, keyrecord_t *record)
- void led_set_*(uint8_t usb_led)
- Modding your keyboard
- Audio output from a speaker
- Recording And Playing back Music
- MIDI functionalty
- Bluetooth functionality
- International Characters on Windows
- RGB Under Glow Mod
- WS2812 Wiring
- PS/2 Mouse Support
- Busywait version
- Interrupt version
- USART version
- Additional Settings
- PS/2 mouse features
- Fine control
- Scroll button
- Debug settings
- Safety Considerations
- Porting your keyboard to QMK
- /keyboards//config.h
- /keyboards//Makefile
- /keyboards//readme.md
- /keyboards//.c
- /keyboards//.h
- Unit Testing
- Google Test and Google Mock
- Use of C++
- Adding tests for new or existing features
- Running the tests
- Debugging the tests
- Full Integration tests
- Tracing variables
- Compatible Microcontrollers
- Please reload this page
- Eclipse
- Please reload this page
- Embedding
- Please reload this page
- FAQ
- Please reload this page
- FAQ Build
- Please reload this page
- FAQ Keymap
- Please reload this page
- Git subtree
- Please reload this page
- HHKB Alt controller
- Please reload this page
- Keymap examples
- Please reload this page
- Kiibohd
- Please reload this page
- mbed cortex porting
- Please reload this page
- Memory write error, use debug for more info
- Please reload this page
- Other Projects
- Please reload this page
- Previously Asked Questions
- Please reload this page
- Report Descriptor
- Please reload this page
- Test for ASCIIDOC
- Please reload this page
- TMK Based Projects
- Please reload this page
- TMK Own Projects
- Please reload this page
- USB HID
- Please reload this page