diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 67 |
1 files changed, 50 insertions, 17 deletions
@@ -1,14 +1,11 @@ -# 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/) - -This is a keyboard firmware based on the [tmk\_keyboard firmware](https://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](https://ergodox-ez.com) keyboard, and the [Clueboard product line](https://clueboard.co). +[](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 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 * [See the official documentation on docs.qmk.fm](https://docs.qmk.fm) @@ -17,21 +14,57 @@ The docs are powered by [Docsify](https://docsify.js.org/) and hosted on [GitHub You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "Edit this page" link at the bottom of any page. + ## Supported Keyboards -* [Planck](/keyboards/planck/) -* [Preonic](/keyboards/preonic/) * [ErgoDox EZ](/keyboards/ergodox_ez/) -* [Clueboard](/keyboards/clueboard/) -* [Cluepad](/keyboards/clueboard/17/) -* [Atreus](/keyboards/atreus/) +* [Planck EZ](/keyboards/planck/ez) +* [Moonlander Mark I](/keyboards/moonlander) + +## Building + +To set up the local build enviroment to create the firmware image manually, head to the [Newbs guide from QMK](https://docs.qmk.fm/#/newbs). +And instead of using just `qmk setup`, you will want to run this instead: -The project also includes community support for [lots of other keyboards](/keyboards/). +```sh +qmk setup zsa/qmk_firmware -b firmware20 +``` ## Maintainers 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 [ZSA Technology Labs](https://github.com/zsa), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy). -## Official Website +# Update Process + +1. Check out branch from ZSA's master branch: + 1. `git remote add zsa https://github.com/zsa/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. +4. `git merge (hash|tag)` + - `git rm -rf docs users layouts .vscode` to remove the docs and user code that we don't want. + - To remove all of the keyboard exept the ones we want: + ```sh + find ./keyboards -mindepth 1 -maxdepth 1 -type d -not -name ergodox_ez -not -name planck -not -name moonlander -exec git rm -rf '{}' \;` + find ./keyboards/planck -mindepth 1 -maxdepth 1 -type d -not -name ez -not -name keymaps -exec git rm -rf '{}' \; + ``` + - To remove all of the keymaps from folder that we don't want: + ```sh + find ./keyboards/ -mindepth 3 -maxdepth 3 -type d -not -name default -not -name oryx -not -name webusb -not -name glow -not -name reactive -not -name shine -not -name keymaps -exec git rm -rf '{}' \; + ``` + - Resolve merge conflicts, and commit. + +4. Commit update + * Include commit info in `[changelog.md](http://changelog.md)` +5. Open Pull request, and include information about the commit + +## Strategy -[qmk.fm](https://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK. +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) |