-
-
Notifications
You must be signed in to change notification settings - Fork 37.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from ErgoDox-EZ/readme_update
Readme Update
- Loading branch information
Showing
1 changed file
with
34 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,46 @@ | ||
| # Quantum Mechanical Keyboard Firmware | ||
| # ZSA's fork of QMK Firmware | ||
|
|
||
| [](https://github.com/qmk/qmk_firmware/tags) | ||
| [](https://travis-ci.org/qmk/qmk_firmware) | ||
| [](https://discord.gg/Uq7gcHh) | ||
| [](https://docs.qmk.fm) | ||
| [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
| [](https://github.com/qmk/qmk_firmware/) | ||
| [](https://github.com/ErgoDox-EZ/qmk_firmware/tags) | ||
| [](https://travis-ci.org/ErgoDox-EZ/qmk_firmware) | ||
| [](https://github.com/ErgoDox-EZ/qmk_firmware/pulse/monthly) | ||
| [](https://github.com/ErgoDox-EZ/qmk_firmware/) | ||
|
|
||
| This is a keyboard firmware based on the [tmk\_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM controllers, and more specifically, the [OLKB product line](https://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). | ||
| This purpose of this fork is maintain a clean repo that only contains the keyboard code that we need, and as little else as possible. This is to keep it lightweight, since we only need a couple of keyboards. This is the repo that the EZ Configurator will pull from. | ||
|
|
||
| ## Documentation | ||
| ## Supported Keyboards | ||
|
|
||
| * [See the official documentation on docs.qmk.fm](https://docs.qmk.fm) | ||
| * [Planck](/keyboards/planck/ez) | ||
| * [ErgoDox EZ](/keyboards/ergodox_ez/) | ||
|
|
||
| The docs are hosted on [Gitbook](https://www.gitbook.com/book/qmk/firmware/details) and [GitHub](/docs/) (they are synced). You can request changes by making a fork and [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "suggest an edit" link on any page of the docs. | ||
| ## Maintainers | ||
|
|
||
| ## Supported Keyboards | ||
| QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The ZSA branch is maintained by Drashna, ZSA's official QMK Liaison, and by Florian Didron, ZSA's lead developer, with input from Erez Zukerman (ZSA CEO). | ||
|
|
||
| * [Planck](/keyboards/planck/) | ||
| * [Preonic](/keyboards/preonic/) | ||
| * [ErgoDox EZ](/keyboards/ergodox_ez/) | ||
| * [Clueboard](/keyboards/clueboard/) | ||
| * [Cluepad](/keyboards/clueboard/17/) | ||
| * [Atreus](/keyboards/atreus/) | ||
|
|
||
| The project also includes community support for [lots of other keyboards](/keyboards/). | ||
| # Update Process | ||
|
|
||
| ## Maintainers | ||
| 1. Check out branch from ZSA's master branch: | ||
| 1. `git remote add zsa https://github.com/ErgoDox-EZ/qmk_firmware.git` | ||
| 2. `git fetch --all` | ||
| 3. `git checkout -B branchname zsa/master` | ||
| 4. `git push -u zsa branchname` | ||
| 2. Check for core changes: | ||
| - [https://github.com/qmk/qmk_firmware/commits/master/quantum](https://github.com/qmk/qmk_firmware/commits/master/quantum) | ||
| - [https://github.com/qmk/qmk_firmware/commits/master/tmk_core](https://github.com/qmk/qmk_firmware/commits/master/tmk_core) | ||
| - [https://github.com/qmk/qmk_firmware/commits/master/util](https://github.com/qmk/qmk_firmware/commits/master/util) | ||
| - [https://github.com/qmk/qmk_firmware/commits/master/drivers](https://github.com/qmk/qmk_firmware/commits/master/drivers) | ||
| - [https://github.com/qmk/qmk_firmware/commits/master/lib](https://github.com/qmk/qmk_firmware/commits/master/lib) | ||
| - These folders are the important ones for maintaining the repo and keeping it properly up to date. Most, but not all, changes on this list should be pulled into our repo. | ||
| 3. `git cherry-pick` the commits we want | ||
| - `git rm docs/* -r` to remove the document updates when cherry picking. Repeat for any keyboard/keymap/etc that have changes that we aren't interested in | ||
| 4. Commit update | ||
| * Include commit info in `[changelog.md](http://changelog.md)` | ||
| 5. Open Pull request, and include information about the commit | ||
|
|
||
| ## Strategy | ||
|
|
||
| QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [Erez Zukerman](https://github.com/ezuk), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy). | ||
| To keep PRs small and easier to test, they should ideally be 1:1 with commits from QMK Firmware master. They should only group commits if/when it makes sense. Such as multiple commits for a specific feature (split RGB support, for instance) | ||
|
|
||
| ## Official website | ||
| ## Merging | ||
|
|
||
| [http://qmk.fm](http://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK. | ||
| Pull Requests should be merged/rebased, not squashed, so we can maintain a commit history that is close to QMK Firmware's, for ease of reference. |