summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2019-03-18[Keymap] Add vim-style keymap for lets split (#5399)Riley Weber
* initial commit * initial commit * fixed indents * spelling, capitalization, and order. * added dota mode keymap, removed old comments * fixed default keymap always having tilde, instead of grave accent and tilde. Improved dota keymap. * lower does not change backspace to delete anymore * corrected pgup/pgdown * changed period on lower from numpad dot to regular dot * added colemak and dvorak * made colemak/dvorak border keys consistent with querty * updated to match current practices, added custom metakeys for dvorak and colemak * added disclaimer about audio * renamed to lowercase * replaced include guards with #pragma once Co-Authored-By: rileyweber13 <rileyw13@protonmail.com> * removed unncessary include Co-Authored-By: rileyweber13 <rileyw13@protonmail.com> * removed defines included in core Co-Authored-By: rileyweber13 <rileyw13@protonmail.com> * replace defines with an enum, switched from custom function to set_single_persistent_default_layer * removed ifndef/include/endif left over from previous build system * removed unnecessary ifdef block * updated soungs to work with set_single_persistent_default_layer
2019-03-18[Keyboard] CannonKeys Instant60 Keyboard (#5433)Andrew Kannan
* Instant 60 * Instant60 changes again * turn off LSE and features * Working RGB underglow :tada: * Add missing files * Update keymap to have reset * Backlighting on * Backlight code for instant60 * Move 072 files to common folder and use it in Instant60 * Updates * Update keyboards/cannonkeys/instant60/rules.mk Co-Authored-By: awkannan <andrew.kannan@klaviyo.com>
2019-03-18[Keymap] add android studio keyboard shortcuts to dvorak 42 key atreus / ↵lucwastiaux
ergodox layouts (#5423) * add SCREEN_NAV layer for copy/pasting within screen * working readreg/paste macros * working read reg / paste macros * write log and tran patterns, and expand * add ls -la shortcut, add tab on combined layer * put delete word on the right pinky key on shell_nav layer * add TAB on the right side, add reset key * added Cloud9 macros * add cloud9 shortcuts to atreus layout * added BROWSER_CONTROL layer * finalized browser control layer * adding comment * add browser control layer to atreus * add flashing command line * remove the tab on combined layer * remove the tomouse * remove mouse layer, change log/tran expand patterns, cleanups * add dumptlog macro * add "delete to home" shortcut * fix conflict * remove unneeded mouse layer * add meh shortcuts on the browser_control layer * add/modify some macros * explain the various layers * putty paste is right mouse button * add android studio shortcuts * allow switching between base and alternate base layouts * replace cloud9 shortcuts with android studio * more android studio shortcuts * add two meh shortcuts on keynav layer * additional android studio shortcut * added defines for android studio
2019-03-18[Keymap] Updated layout after some months of testing. (#5427)FiNeXdesign
* Updated layout after some months of testing. The current setup looks quite better than the initial one. It's not perfect but it allows me to work quite well. The only big problem is the Alt modifiers on the home row which sometimes break the typing if keys are pressed too fast. I'm also not satisfied by the TAB key position on the thumb cluster. Main improvements since previous push: - Shift layouts on both halves - Moved around symbols - Improved number/fn keys - Reorganized thumbs * Used enum as suggested by @drashna :-)
2019-03-18[Keyboard] Corrected layout for top row keys (#5429)Adam Newbold
* Corrected column count and adjusted layouts to include missing key The original version reflected 14 columns and omitted KC_GRV, the 15th key on the top row. This revision adds support for the 15h key, and also updates the default (Tsangan) layout to include the HHKB layer keys. * Reverted config.h to version in master branch * Moved K413 to the correct location * Added info.json * Update keyboards/1upkeyboards/1up60hte/1up60hte.h Co-Authored-By: newbold <adam@neatnik.net> * Update keyboards/1upkeyboards/1up60hte/info.json Co-Authored-By: newbold <adam@neatnik.net> * Update keyboards/1upkeyboards/1up60hte/keymaps/default/keymap.c Co-Authored-By: newbold <adam@neatnik.net> * Update keyboards/1upkeyboards/1up60hte/keymaps/hhkb/keymap.c Co-Authored-By: newbold <adam@neatnik.net> * Update keyboards/1upkeyboards/1up60hte/keymaps/hhkb/keymap.c Co-Authored-By: newbold <adam@neatnik.net> * Update keyboards/1upkeyboards/1up60hte/keymaps/default/keymap.c Co-Authored-By: newbold <adam@neatnik.net>
2019-03-18[Keyboard] Add Jot50 handwired board (#5431)jotix
2019-03-18[Keyboard] layout fixed in jotanck.h (#5432)jotix
2019-03-18[Keyboard] correct indicator light states (#5434)holtenc
function of indicator lights was inverted. these changes correct that.
2019-03-18[Keyboard] Fix matrix positions for HotDox (#5437)layne001365
* Add HotDox * Update keyboards/hotdox/config.h Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/config.h Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/config.h Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/config.h Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/keymaps/default/keymap.c Co-Authored-By: layne001365 <layne.guan@gmail.com> * * Update - keyboards/hotdox/config.h - keyboards/hotdox/hotdox.h - keyboards/hotdox/info.json - keyboards/hotdox/left.h - keyboards/hotdox/left.c - keyboards/hotdox/rules.mk * Replace EPRM with EPRM - keyboards/hotdox/keymaps/default/keymap.c - keyboards/hotdox/keymaps/eozaki/keymap.c - keyboards/hotdox/keymaps/kloki/keymap.c * Remove keymaps readme.md * Remove twimaster.h/ twimaster.c * * Update - remove FORCE_NKRO from keyboards/hotdox/config.h - keyboards/hotdox/hotdox.c - keyboards/hotdox/hotdox.h - keyboards/hotdox/keymaps/default/keymap.c - keyboards/hotdox/left.c - keyboards/hotdox/readme.md - keyboards/hotdox/rules.mk * Update keyboards/hotdox/keymaps/default/keymap.c Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/keymaps/default/keymap.c Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/rules.mk Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/rules.mk Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/rules.mk Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/rules.mk Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/rules.mk Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/hotdox.h Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/rules.mk Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/rules.mk Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/config.h Co-Authored-By: layne001365 <layne.guan@gmail.com> * Update keyboards/hotdox/config.h Co-Authored-By: layne001365 <layne.guan@gmail.com> * [Keymaps] reverse the K5C<->K5A, L53<->L51, R55<->R53 position.
2019-03-18[Keymap] Arkag Userspace Update (#5438)Alexander Kagno
* fresh commit for a new fork for PR to upstream/master * gaming mode added, lighting changes for other modes * rules.mk fixed... * fixed collision issue with aesthetic and shifty modes * fixed collision issue with aesthetic and shifty modes * troubleshooting game mode failing * moved game tapdance key to default layer, fixed issue
2019-03-17New RGB Matrix effect: Single color reactive (#5330)M-AS
* Adds new RGB Matrix effect: rgb_matrix_config'd reactive LEDs * [Docs] Adds disable for new effect * [Docs] Added new effect to list of effects
2019-03-17Align docker and vagrant base images (#4905)zvecr
* Align docker and vagrant base images - update box to debian 9.6 * Align docker and vagrant base images - lock docker image to debian 9 * Align docker and vagrant base images - update vagrant docker to debian 9
2019-03-17Unicode fix for new wincompose version (#5082)cubimon
* unicode fix for new wincompose version * move wincompose case to linux * Change unicode input end to enter
2019-03-17[Keymap] Improvements to Samuel's literate keymap (#5428)Samuel Jahnke
* added my own keymap * changed thing * updated keymap Samuel * updated laypout for better one handed use * updated stuff I want * happy with my lagout * formatting * Added new literate config * made everything nice * cleaned * fixed spelling and two small bugs in macros * Made press and lift function for modifiers * made taps occur on press instead of release * added oneshot keys and chars cant be negative! * removed debug message * Added command and qwerty layers * fixed bug with oneshot layer * same bug, different key
2019-03-17Added 4 new songs to song_list.hDDRnJn
Added Liebesleid by Kriesler (or Rachmaninoff), Michishirube from Violet Evergarden, Melodies of Life from Final Fantasy 9 and Eyes on Me from Final Fantasy 8
2019-03-17[Keymap] Jotix (#5424)jotix
* ortho_4x12 jotix2 layout * ortho_4x12 jotix2 layout
2019-03-17[Keymap] Add a tweaked Redox keymap (#5422)Nik Richers
* Add nrichers keymap * Additional keymap tweaks, add readme info * Improve descriptions for changes from default keymap * Add image of keymap, update .gitignore to * Add image link Adds an image of the modified keymap. * Improve legibility of keymap changes with colour coding * Tinker with color codes in Markdown * Experiment with colour codes * Tinker more with colour codes * Figured out the easiest way to include colour coding * Undo earlier .gitignore change
2019-03-17[Keyboard] XD75 refactor (#5420)noroadsleft
* Refactor layout macro names Update the names of the layout macros to reflect QMK's desired usage. - KEYMAP renamed to LAYOUT - colinta keymap updated accordingly - KC_KEYMAP renamed to LAYOUT_kc - mtdjr keymap updated accordingly * Update xd75.h to use #pragma once include guard * Update keymaps to use QMK_KEYBOARD_H * Refactor default keymap - updated to use layout macro - remove deprecated action_get_macro function - add functions from QMK keymap.c template - process_record_user - matrix_init_user - matrix_scan_user - led_set_user * Update supporting files - updated config.h files to use #pragma once include guard - remove errant QUANTUM_DIR code block * Rename readme files to fully lowercase filenames * Restructure keyboard readme Updated the readme to better align with the current QMK template. * Bugfixes to supporting files
2019-03-15[Docs] Add VSCode guide to docs (#5124)Drashna Jaelre
* Add VSCode guide to docs * Fix settings menu enumeration * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com>
2019-03-15[Keyboard] Add handwired split tester (#5413)Danny
* Add handwired split tester * Update keyboards/handwired/splittest/readme.md Co-Authored-By: nooges <nooges@users.noreply.github.com> * Update keyboards/handwired/splittest/readme.md Co-Authored-By: nooges <nooges@users.noreply.github.com>
2019-03-15Add avrdude split EE_HANDS flash commands (#5414)Danny
* Add EEPROM avrdude flashing commands for setting handedness * Update docs with info on flashing EEPROM handedness files with commands
2019-03-15rgblight split transfer non-eeprom config (#5396)Len Trigg
* Make rgblight_update_dword not update eeprom (we already have eeconfig_update_rgblight for that). Make split i2c keyboards transfer active rgblight config rather than eeprom saved version of rgblight config, enabling runtime changes that aren't persisted to eeprom. * prev_level and prev_rgb only store successfully transmitted values
2019-03-15[Keymap] Keymap for Idobo (#5402)GreenShadowMaker
* greenshadowmaker keymap for idobo xd75 massdrop * remove uneeded config.h * corrected format to match convention instead of xd75 where I accidentally started from
2019-03-15[Keymap] Update to drashna keymaps: Conform to QMK Standards Edition (#5377)Drashna Jaelre
* Use correct functions for dip switch code * Some planck cleanup * Hopefully fix RGB Sleeping with RGB Matrix * Add rgbmatrix extern * Add numpad 5x6 layout * RGB Tweaks * Add RGB startup animation * Minor RGB Fixes * Turn off RBG on planck * Enable separate storage of EEPROM * Update Macro pad * Add BJohnson Keymap and minor darshna tweaks * Clean up rgb and other code for new numpad * Remove clicky hachy thing * Update my code to use built in MOD_MASK defines * Fix up modifier calls * Tweak to KC_MAKE * Tweak to KC_MAKE * Add Semi-colon to numpad * Preprocess out rgb matrix stuff if not enabled * Formatting of KC_MAKE * Add stuff for matrix and light rgb coexistance * Fix bad spelling * Change where layer indication shows based on rgblight status * Force set mods in KC_MAKE * Optimize CRKBD
2019-03-15Fix return value of i2c_readReg and i2c_receive (#5410)zvecr
2019-03-14[Keymap] Greenshadowmaker keymap for ergodash (#5403)GreenShadowMaker
* My Inital Keymap, adjusted for not removing outer keys, and using large inner key * First working version of keymap * RGB investigate * Updated Keymap, added keyboard-layout-editor.com json file * minor fix * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/config.h Ah! Thanks fort the clarification, it was a blind copy/paste Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/config.h Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/config.h Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/config.h Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/rules.mk Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/keymap.c Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/keymap.c Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/keymap.c Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * Update keyboards/ergodash/rev2/keymaps/greenshadowmaker/keymap.c Co-Authored-By: GreenShadowMaker <39226745+GreenShadowMaker@users.noreply.github.com> * removed persistent_default_layer_set and the QWERTY section as suggested
2019-03-14[Keymap] Added Boy_314's layout for half n half keyboard (#5373)Boy_314
* added Boy_.314's layout for halfnhalf keyboard * reset rules.mk to default * update keymap with qwerty layout, and enable tap dancing * fixed formatting in layout visualization * added rules.mk to custom layout * added mod tap for ctrl/capslock * fixed typo in config.h, remove excess in rules.mk, revert half_n_half rules.mk
2019-03-14Align use of atmega32a program script (#5259)zvecr
* Remove duplicate 'program' files and refactor to use atmega32a_program.py * Update readme references from 'program' to 'atmega32a_program.py'
2019-03-14[Keyboard] new keyboard lovelive9 (#5266)ginjake
* new keyboard lovelive9 * Update keyboards/lovelive9/config.h thank you Co-Authored-By: ginjake <hsginjake123@gmail.com> * Apply suggestions from code review Co-Authored-By: ginjake <hsginjake123@gmail.com> * fix review * fix readme * move handwired * Update keyboards/handwired/lovelive9/keymaps/default/keymap.c thanks Co-Authored-By: ginjake <hsginjake123@gmail.com> * Apply suggestions from code review commit suggestion Co-Authored-By: ginjake <hsginjake123@gmail.com> * fix spell miss * fix review * fix col and row * fix layout define
2019-03-14[Keyboard] Inital port of xd96 (#5401)zvecr
* Initial import of xd96 based on xd84 code * Configure xd96 port expander mapping * Fix xd96 led count * Fix xd96 port expander reading * Fix xd96 port expander reading * Fix xd96 LAYOUT matrix mapping * Add additional links for xd96 Hardware Availability * Correct Configurator config Co-Authored-By: zvecr <git@zvecr.com> * Readme review comments Co-Authored-By: zvecr <git@zvecr.com>
2019-03-14Fix ascii art (#5407)Brendan Wrafter
2019-03-14[Keyboard] Georgi Support (#5384)Jeremy Bernhardt
* Working on chording * Working on chording * Got layouts in order * Initial Georgi support * forgot to add keymaps * Updated readme * Update keyboards/georgi/keymaps/template/readme.md Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/georgi.h Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/keymaps/default/keymap.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/keymaps/default/keymap.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/rules.mk Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/rules.mk Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/matrix.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/georgi.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/georgi.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/rules.mk Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/keymaps/default/keymap.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/keymaps/template/keymap.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/matrix.c Co-Authored-By: germ <jeremythegeek@gmail.com> * Disabled features, updated info * Update keyboards/georgi/config.h Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keyboards/georgi/config.h Co-Authored-By: germ <jeremythegeek@gmail.com> * Fixed info.json
2019-03-14fresh commit for a new fork for PR to upstream/master (#5406)Alexander Kagno
2019-03-14Added info.json for mt980 keyboard and fixes to walker keymap (#5391)walkerstop
* Added info.json and minor fixes to walker keymap * Fix url * Update keyboards/mt980/info.json Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/info.json Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/info.json Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/info.json Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/info.json Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/info.json Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/info.json Co-Authored-By: walkerstop <walkerstop@gmail.com> * Fix user calling keymap functions * cancel oneshot layer on KC_TRNS * Fix to oneshot layer handling * Fix oneshot handling of reset * Move bootmagic key to Esc where it normally resides * Remove deprecated function * Treat shift-numlock as shift-insert in Walker layer
2019-03-13Add support for THE60 (#5385)Erovia
2019-03-13Added 1up60rgb keymap: mdyevimnav (#5386)Michael Dye
Added keymap for 60% board 1up60rgb. The map provides VIM-style navigation on a second layer (L1) with HOME, PGDN, PGUP, and END keys on that same layer one row below the home row. The layout is used by https://github.com/michaeldye.
2019-03-13Fix i2c calls for HotDox keyboard (#5387)Drashna Jaelre
2019-03-13Sleep until USB port becomes writable before running avrdude (#5393)Michael F. Lamb
* sleep until usb port becomes writable before running avrdude * only wait for a writable USB port when not on MSYS using MINGW or MSYS: sleep for one second, as before. otherwise: wait for the port to become writable. * typo * typo
2019-03-13[Keymap] Some more improvements to keymap, currency symbols.. (#5395)Christian Westerlund
acute accent and pipe character also
2019-03-13[Keymap] Add atreus, ergotravel and org60 keymaps (#5381)Jarred Steenvoorden
* Add atreus, ergotravel and org60 keymaps * Cleanup my keymap config files
2019-03-13archetype keymap for jj50 (#5397)Iason Dimitrakopoulos
* archetype keymap for jj50 keyboard * archetype keymap for jj50 keyboard * PR fixes proposed by mechmerlin
2019-03-12Wheat Field Peripherals mt980 (FC980M Layout) PCB Support (#5374)walkerstop
* mt980 keyboard support * Update manufacturer name * Correct indicator LEDs, add walker keymap * Added readme.md * Update keyboards/mt980/mt980.c Co-Authored-By: walkerstop <walkerstop@gmail.com> * Treat number pad + and enter as pgup and pgdn when number lock is off * Update keyboards/mt980/mt980.c Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/mt980.c Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/readme.md Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/readme.md Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/readme.md Co-Authored-By: walkerstop <walkerstop@gmail.com> * Update keyboards/mt980/rules.mk Co-Authored-By: walkerstop <walkerstop@gmail.com>
2019-03-12Minor readme fix (#5389)yiancar
2019-03-12Add new keyboard Plaid and ATMEGA328p support (#5379)Takuya Urakawa
* add plaid * Change usb vid/pid to free id from vusb Trivial fix for vusb core * update readme * update info.json default keymap * fix typo * Replace copyright
2019-03-12Next set of split_common changes (#4974)James Churchill
* Update split_common to use standard i2c drivers * Eliminate RGB_DIRTY/BACKLIT_DIRTY * Fix avr i2c_master error handling * Fix i2c_slave addressing * Remove unneeded timeout on i2c_stop() * Fix RGB I2C transfers * Remove incorrect comment
2019-03-12[Keyboard] Lily58 Add info.json file (#5354)Naoki Katahira
* Add info.json file * fix info.json * fix2 info.json * Update keyboards/lily58/rev1/info.json Co-Authored-By: kata0510 <kata0510.com@gmail.com> * Update2 keyboards/lily58/rev1/info.json Co-Authored-By: kata0510 <kata0510.com@gmail.com>
2019-03-12KPrepublic bm16a port (#5383)zvecr
* Initial bm16a port * Initial bm16a port - fix readme formatting
2019-03-12Fix speed issues with RGB Matrix in the DZ60RGB (#5380)moyi4681
* Fix speed issues with RGB Matrix in the DZ60RGB * keep boards in sync
2019-03-12Keymap update (#5382)Callum Oakley
* home and end on fn layer (for forward and back with left hand) * space movement shortcuts * mouse layer
2019-03-11[Keyboard] Satisfaction75 Protoype/Rev1 split, and new VIA features (#5303)Andrew Kannan
* Add satisfaction75 revision 1 * Update manufacturer * Add tester layout and update rev1 comments * Add ifdef guards for OLED for tester * Add oled disabling rules * Update to save backlight settings and setup for VIA custom config * Add new VIA values to satisfaction75 * Safety guard in clock set mode * Fix mistaken doc edit * Address PR comments * bring the default back to pass travis CI * Address further PR comments