diff options
author | Nathan Sharfi <me@ngalt.com> | 2016-07-31 14:02:25 -0700 |
---|---|---|
committer | Nathan Sharfi <me@ngalt.com> | 2016-07-31 14:02:25 -0700 |
commit | d889648d5373b7ff77dc7bc4b369c628e8336b45 (patch) | |
tree | 35c6eb194417242958baf54b36f0ff3a56e378f1 /keyboards/handwired/traveller/readme.md | |
parent | 6428069eb70f5cc47ac1f3f9acf3daea14fb9097 (diff) | |
parent | b25dbc484d639210c53d8e13f79cf5a77f2faaaa (diff) | |
download | qmk_firmware-d889648d5373b7ff77dc7bc4b369c628e8336b45.tar.gz qmk_firmware-d889648d5373b7ff77dc7bc4b369c628e8336b45.zip |
Merge branch 'master' of github.com:jackhumbert/qmk_firmware
# Conflicts:
# keyboard/ergodox_ez/keymaps/zweihander-osx/keymap.c
# keyboard/ergodox_ez/keymaps/zweihander-osx/zweihander-osx.hex
Diffstat (limited to 'keyboards/handwired/traveller/readme.md')
-rw-r--r-- | keyboards/handwired/traveller/readme.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/keyboards/handwired/traveller/readme.md b/keyboards/handwired/traveller/readme.md new file mode 100644 index 0000000000..646844b1d7 --- /dev/null +++ b/keyboards/handwired/traveller/readme.md @@ -0,0 +1,35 @@ +traveler keyboard firmware +====================== + +## Traveller Specific Info ## +The traveller is a varient on the atreus keyboard. +Like the Atreus, it is designed to be a good compromise between size and ergonomics. + +key differences are +- an additional column for each pinky +- an RGB LED in the center to show the current layer +- more finger stagger, splay angle and contoured keycaps (F2 profile for space key). + +You can make your own traveller keyboard by using the openscad tools from the atreus repository, and adding a hole for the LED to shine through. + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent README.md](/README.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboard/traveler 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. + +### Default +To build with the default keymap, simply run `make`. + +### Other Keymaps +Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` and see keymap document (you can find in top README.md) and existent keymap files. + +To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: +``` +$ make KEYMAP=[default|jack|<name>] +``` +Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. |