dax/qmk
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Traveller cleanup (#13441)

Browse Source 
* Traveller cleanup

* Update keyboards/handwired/traveller/info.json

Co-authored-by: Joel Challis <git@zvecr.com>

Co-authored-by: Joel Challis <git@zvecr.com>
This commit is contained in:
Ryan
2021-07-05 20:45:31 +10:00
committed by GitHub
parent eb7178b542
commit 4c1c112a16
8 changed files with 336 additions and 480 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
keyboards/handwired/traveller/readme.md
View File

@@ -1,35 +1,21 @@
traveler keyboard firmware
======================
# Traveller
## 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.
The Traveller is a variant 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).
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.
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
Make example for this keyboard (after setting up your build environment):
For the full Quantum feature list, see [the parent README.md](/readme.md).
make handwired/traveller:default
## Building
Flashing example for this keyboard:
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.
make handwired/traveller:default:flash
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.
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).