Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Daisy port #2016

Merged
merged 13 commits into from
Nov 22, 2017
Prev Previous commit
Next Next commit
Update readme.md
  • Loading branch information
westfoxtrot committed Nov 7, 2017
commit ed8ff89ac97344ed0151380b81f463ed052bcf75
27 changes: 10 additions & 17 deletions keyboards/daisy/readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
xd75 keyboard firmware
Daisy 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!
This is a QMK port for the Daisy a 40% keyboard produced by KPRepublic. The board is available here: http://tinyurl.com/yc26lq22
This is my first port to QMK so apologies if it is a little rough around the edges.

## Quantum MK Firmware

Expand All @@ -10,38 +11,30 @@ 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
keyboards/daisy folder. Once your dev env is setup, you'll be able to
type `make` to generate your .hex - you can then use atmel FLIP/avrdude
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.
To build with the default keymap, simply run `make daisy:default` from the root directory (i.e. two levels above this file), and to install via DFU, `make daisy: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
$ sudo make daisy: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 the layout I personally use on the Daisy and the one I have found the most comfortable.

Keymaps follow the format **__\<name\>.c__** and are stored in
subdirectories under `keyboards/xd75/keymaps`
A printable picture showing this layout is available here: https://imgur.com/a/HwnAP

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>]
$ make daisy:[default|<name>]
```