From a07d1f22aa111d3aaf0903a3cbaeb27b98f2c55e Mon Sep 17 00:00:00 2001 From: Christopher Browne Date: Thu, 14 Sep 2017 14:02:49 -0400 Subject: Some revisions to cbbrowne Planck keymap, and a preliminary xd75 keymap (#1715) * Add HOME/END keys as upper/lower on arrow-up/down * Reduce .hex file size by turning off unneeded options * Put digit keypad onto left hand upon RAISE; this will sometimes be preferable to double-hits of right hand * Latest super latest version merge * cbbrowne keymap for XD75re * starting notes on XD75re keymap plans * First draft of bottom row of QWERTY * Switch my special bottom line over to QCENT * Dunno * Filling in wanted keys, bit by bit... * Add copyright, extra macro * Clean up comments, remove some experimental code I didn't like * TODO plans for xd75re * clean up keyboard layout * QCENT2 is my new experiment for the main keyboard... * Add a few more main layer keys, and modify LOWER to shift things outwards to conform with main layer * Clean up RAISE layer to conform with main layer, remove QCENT layer as QCENT2 is the new thing * More xd75 changes, now that I actually have it in hand * shift keymap around, as original attempt was a bit too aggressive in keeping to the edges * more revs to XD75 * Dropping parts of the centre keypad in favor of Keys I Really Need * Improve documentation to conform with how builds are done now * Improve documentation to conform with how builds are done now * Add cbbrowne rules file as alternative to having the rules in Makefile * Makefile not needed anymore for individual keymap --- keyboards/xd75/readme.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) (limited to 'keyboards/xd75/readme.md') diff --git a/keyboards/xd75/readme.md b/keyboards/xd75/readme.md index 0bc82be91..28a252332 100644 --- a/keyboards/xd75/readme.md +++ b/keyboards/xd75/readme.md @@ -9,22 +9,40 @@ For more info on this firmware (and how to make it your own), head over to [qmk. ## Building -Download or clone the whole firmware and navigate to the keyboards/xd75 folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. - -Depending on which keymap you would like to use, you will have to compile slightly differently. +Download or clone the whole firmware and navigate to the +keyboards/xd75 folder. Once your dev env is setup, you'll be able to +type `make` to generate your .hex - you can then use the Teensy Loader +to install the resulting .hex file, or have the `make` process install +it using DFU. ### Default -To build with the default keymap, simply run `make default`. +To build with the default keymap, simply run `make xd75-default`, and +to install via DFU, `make xd75-default-dfu`. + +Note that DFU is likely to require root permissions, so installing the +firmware likely requires a command line like: + +``` +$ sudo make xd75-default-dfu +``` ### Other Keymaps -The "default" keymap included is basically the OLKB Atomic keymap with a few buttons added for RGB underglow control. This should be usable as a starting point, but most people will be best served creating their own keymap and flashing it - more info on creating your own keymap is available in [the official QMK documentation](https://docs.qmk.fm). +The "default" keymap included is basically the OLKB Atomic keymap with +a few buttons added for RGB underglow control. This should be usable +as a starting point, but most people will be best served creating +their own keymap and flashing it - more info on creating your own +keymap is available in [the official QMK +documentation](https://docs.qmk.fm). + +Keymaps follow the format **__\.c__** and are stored in +subdirectories under `keyboards/xd75/keymaps` -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: +To build the firmware binary hex file for a specific keymap, and +install it, using DFU, just do `make` with a keymap like this: ``` -$ make [default|jack|] +$ make xd75-[default|] ``` -Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder. -- cgit v1.2.3-24-g4f1b