800ec55dfc
* redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
xd75 keyboard firmware
|
|
======================
|
|
|
|
The XD75Re is a 15x5 full-grid ortholinear keyboard manufactured by XIUDI. This port of the QMK firmware is my first shot at using QMK, so if you see any features done wrong (or just plain missing), feel free to fix them and put in a pull request!
|
|
|
|
## Quantum MK Firmware
|
|
|
|
For more info on this firmware (and how to make it your own), head over to [qmk.fm](http://qmk.fm).
|
|
|
|
## 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 install the resulting .hex file, or have the `make` process install
|
|
it using DFU.
|
|
|
|
### Default
|
|
|
|
To build with the default keymap, simply run `make xd75:default` from the root directory (i.e. two levels above this file), and to install via DFU, `make xd75:default:dfu`, also from the root directory.
|
|
|
|
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).
|
|
|
|
Keymaps follow the format **__\<name\>.c__** and are stored in
|
|
subdirectories under `keyboards/xd75/keymaps`
|
|
|
|
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 xd75:[default|<name>]
|
|
```
|
|
|