No description
Find a file
James Young 3152bf572b
[Docs] Restructure of Git Best Practices doc (#7231)
* Add "Resynchronizing an Out-of-Sync Git Branch" doc

* Update (Git) Best Practices doc title and filename

* Rename Branch Resync doc

* fork Best Practices doc into multiple files

* Add the doc list to Git Best Practices doc

* Update sidebar

* Update internal references

* Update sidebar - add subsection

* Update Your Fork's Master page title

* title case on Git Best Practices main doc

* ... and in the Resynchronizing a Branch doc

* Please read Part 1

I worked really hard on this, okay?

* Please use branches, too.

* suggestions by mtei

* change note about adding multiple files

* note that the name given the remote repo is arbitrary

* suggestions by fauxpark

* Git Best Practices -> Best Git Practices

Reads more naturally.

* rephrase hint block regarding remote name

* rework the resynchronization instructions per mtei

* use hint boxes for reference to Part 1 doc

I may be addicted to hint boxes. I'm sorry fauxpark. 😢

* add some clarity about the upstream repo

* wordsmithing per mtei

* restyle the shell code blocks

Makes them more consistent to the other docs in this section.
2019-12-02 18:47:02 -08:00
.github Fix typos in stale.yml (#7489) 2019-11-26 21:45:18 +00:00
.vscode
bin Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
docs [Docs] Restructure of Git Best Practices doc (#7231) 2019-12-02 18:47:02 -08:00
drivers IS31FL3733 Dirty page fix (#7079) 2019-11-25 20:33:52 +00:00
keyboards [Keyboard] Add handwired/floorboard (#7478) 2019-12-02 12:03:35 -08:00
layouts [Keyboard] Add three missing layouts (#7441) 2019-11-21 20:25:19 -08:00
lib Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
quantum Remove check for EH define (#7525) 2019-12-02 17:10:09 +00:00
tests
tmk_core Remove vusb 'reset to bootloader' hid message due to security implications (#7456) 2019-11-25 20:33:02 +00:00
users [Keymap] Add RGB keycodes to keymap, enable RGB_MATRIX on crkbd (#7499) 2019-11-29 15:48:11 -08:00
util Fix install for Linux Ubuntu (#7520) 2019-12-02 08:56:38 +11:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore [Docs] Update hand wire guide (#7044) 2019-10-25 11:48:59 -07:00
.gitmodules
.travis.yml CI - Fix change detection (#7038) 2019-11-04 16:18:57 -08:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_json.mk Make generating keymap.c from JSON more reliable 2019-11-12 20:37:28 -08:00
build_keyboard.mk
build_layout.mk
build_test.mk
CODE_OF_CONDUCT.md
common.mk
common_features.mk [Core] Convert Dynamic Macro to a Core Feature (#5948) 2019-11-04 22:59:13 -08:00
Dockerfile
Doxyfile
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile Allow 'make all:<user>' to not build EVERYTHING (#7402) 2019-11-20 22:32:16 +00:00
message.mk
nose2.cfg
readme.md Set up language fallback for docs, and update translation guidelines (#7403) 2019-11-23 16:07:15 +00:00
requirements.txt Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
secrets.tar.enc
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
shell.nix Fix shell.nix by pinning nixpkgs (#6213) 2019-11-14 12:00:36 -08:00
show_options.mk
testlist.mk
Vagrantfile

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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

Documentation

The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit Document" link at the bottom of any page.

Supported 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. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.