Commit Graph

175 Commits (19753788c1404f43f2a3000a68c336170cb7eb5c)

Author SHA1 Message Date
Jack Humbert d069a42c07
Update getting_started_github.md 7 years ago
Arialdo Martini 32bb8f6b8a Improvements to documentation (#1919)
* Typo: Github => GitHub

* Typo: windows => Windows, docker => Docker, and some punctuations

* "QMK Introduction" links to the right file

* "Unix" rather than "UNIX", which is a trademark

* Directory name is "keyboards", not "keyboard"

* "handwired" is a subdirectory of "keyboards"

* Punctuation and minor fixes

* macOS rather than Mac

* Punctuation and other minor fixes

* Vagrant Guide links to an existing file

* Jun Wako referenced with his name rather than his nickname

* Saxon genitive 's outside the link
7 years ago
Jack Humbert 38261920a9
update hand wiring link 7 years ago
tsankuanglee 04b9b62bdc RETRO_TAPPING (#1922)
* add RETRO_TAP: tap anyway, even after TAP_TERM, if no interruption

* consistent variable name

* add option doc

* change name for consistency

* make RETRO_TAPPING default to off
7 years ago
Zach Burchill 4c1164c469 fixed two typos
I'm almost 100% sure "else if (state->count = 2) {" was a typo (it should have two ='s for a logical operator), and I'm *pretty* sure "if (state->interrupted || state->!pressed) return SINGLE_TAP;" has a typo. At least, it returns an error on my machine saying something about an unexpected '!'.  
I changed it to a slightly longer form (i.e., "state->pressed==0"), and that worked fine.
7 years ago
Jeremy Cowgar 49c32021db Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 7 years ago
Jeremy Cowgar 76d807fe7d Fix code example in auto shift docs 7 years ago
Jeremy Cowgar bf1fedc05e Fixed various feature links 7 years ago
Jack Humbert 4d421ee31c adds flashing docs 7 years ago
skullydazed 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888)
* fix #1313 by documenting more config.h options

* Clean up and organize documentation
7 years ago
Sebastian Kaim 1f43495922 Added a new keycode for cycling through RBG modes which reverses directions when shift is hold.
This commit adds a new keycode `RGB_SMOD` which is the same as `RGB_MOD` (cycle through all modes),
but when it is used in combination with shift it will reverse the direction.
7 years ago
Daniel Gordon 725aa5b820 Update to Tap-Dance Docs for Fast Typists
* Quad function tap dance works as intended when typing fast
    * Example 4 in doc has been updated

Change-Id: If33406299e2eed49152c495da92f4977dfdc1e2f
7 years ago
Jack Humbert 06f196c589 Creates a userspace for keymaps (#1559)
* create a user space

* adds example

* document, add readme.md

* jackhumbert userspace, ergodox keymap
7 years ago
skullY 9bb259b660 Fix the naming for clueboard files 7 years ago
James 3276c4c56a Minor punctuation and grammar edits. 7 years ago
Jason Milkins 78923cb884 Fix code backticks on Frequently Asked Build Questions docs 7 years ago
Jason Milkins a860d9d628 Fix missing code backticks 7 years ago
Daniel Gordon 383e508bc5 Quad Function Tap Dance added to TD Doc
* Added section to example, detailing how to accomplish the
        'quad-function' tap dance.
    * Refactored TD documentation to clearly separate different complex
        examples

Change-Id: Ifc1495d1142849c771418fdabc458c04c48311e6
7 years ago
skullydazed ad49db8cd2 Address #1689 by using a formula to define the breathing curve (#1692)
* Address #1689 by using a formula to define the breathing curve and exposing defines to control the shape of the curve.

* Tweak the behavior of breathing for clueboard
7 years ago
Dylan Khor aa660c1eb7 Broken link found in issue #1845 7 years ago
Jack Humbert 800ec55dfc Make arguments redo, subproject elimination (#1784)
* 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
7 years ago
Jonathan Arnett 4c0ff7b7ea Remove reference to Ergodox subprojects from docs
At one time, "ez" and "infinity" may have been subprojects of a
unified "ergodox" project, but this is not currently the case. Running
`make ergodox-ez-default-teensy` (or similar), as the documentation
currently implies, does not work.
7 years ago
skullY db5afb05cf Fix the presentation of the contribution guide 7 years ago
skullydazed 2db4ad2133 Write a contributing guide. (#1827) 7 years ago
Jesper Brix Rosenkilde 966e2660cf Add option to reverse PS2 mouse axes and scrolling 7 years ago
Snipeye cfd118d158 Added Dichotemy Keyboard, updated docs for Pointing Device (#1817)
* Added Dichotemy Keyboard, updated docs for Pointing Device

* Updated readme

* Updated mouse report pointer in pointing_device.c
7 years ago
lyuts d8c62e4238 Fixed typo in docs. (#1818) 7 years ago
Snipeye ee13228486 Generic Pointing Device (#1767) 7 years ago
Dylan Khor 0cc62459a7 Minor typo 7 years ago
Sebastian Kaim 29bcffb3f3 Edited a minor typo in feature_bootmagic.md. 7 years ago
Daniel Gordon 03de0c8575 Reference to rules.mk in tap dance docs added
Change-Id: I64aa6f95a30ab05f0ed3f499e54b9e125d379fad
7 years ago
Max Riveiro f1451b4b04 Fix HSV Color Wheel image on RGB Light page (#1773)
Signed-off-by: Max Riveiro <kavu13@gmail.com>
7 years ago
Lukas Werling 1ad941e984 Add shell.nix for NixOS users 7 years ago
Zach Burchill 809c9258c1 Fixed typo of "multually" to "mutually" 7 years ago
surlyjake c8d365f5da platform descriptions to match master keycodes.md documentation 7 years ago
surlyjake 957e44231a updated keycodes media descriptions
Platform compatibility descriptions added for mute, volume up/down
7 years ago
Jeremy Cowgar a89183591c Fixed a few typos and spelling errors in auto shift feature document 7 years ago
Jeremy Cowgar abba393f57 Added Auto Shift, tap key = normal, hold key = shifted state. 7 years ago
Jack Humbert 7ad924bae5 Updates send_string functionality, adds terminal feature (#1657)
* implement basic terminal stuff

* modify send_string to read normal strings too

* add files bc yeah. working pgm detected

* pgm detection apparently not working

* adds send string keycodes, additional keycode support in send string

* implement arguments

* [terminal] add help command

* [terminal] adds keycode and keymap functions

* [terminal] adds nop.h, documentation

* update macro docs
7 years ago
skullydazed 4cdcbdb861 Remove all Makefiles from the keyboards directory. (#1660)
* Remove all Makefiles from the keyboards directory.

* update keymaps added in the last 8 days

* Ignore keyboard/keymap makefiles

* update hand_wire to reflect our new Makefile-less reality

* Update the make guide to reflect the new reality

* move planck keymap options to rules.mk

* update planck keymaps 4real

* trigger travis

* add back build_keyboard.mk

* restore changes to build_keyboard
7 years ago
skullydazed 4580d3a730 RGB improvements (#1684)
* Allow the knight animation to be restricted to a portion of the LED strip

* Add keys for jumping directly to particular animation modes

* Remove orphaned break statements

* Tweak the `RGB_MODE` buttons so they cycle through the same mode.

* small indentation fix
7 years ago
Will Jiang 0ce45eb0b7 Update mac guide (#1665)
`avr-libc` is no longer, and it's called `avr-gcc` now. https://github.com/osx-cross/homebrew-avr

Also you need `gcc-arc-none-eabi` to be able to compile in my experience.
7 years ago
Jack Humbert 5f154f0a00 Update feature_common_shortcuts.md 7 years ago
Marco Fontani da83f04a30 add UC_OSX_RALT to make unicode use the Right Alt key on OSX 7 years ago
Jack Humbert d2ff66a985 Creates a layouts/ folder for keymaps shared between keyboards (#1609)
* include variables and .h files as pp directives

* start layout compilation

* split ergodoxes up

* don't compile all layouts for everything

* might seg fault

* reset layouts variable

* actually reset layouts

* include rules.mk instead

* remove includes from rules.mk

* update variable setting

* load visualizer from path

* adds some more examples

* adds more layouts

* more boards added

* more boards added

* adds documentation for layouts

* use lowercase names for LAYOUT_

* add layout.json files for each layout

* add community folder, default keymaps for layouts

* touch-up default layouts

* touch-up layouts, some keyboard rules.mk

* update documentation for layouts

* fix up serial/i2c switches
7 years ago
Joe Wasson bdc0880ca5 Add compile error if too many endpoints are defined for the ATmega32U4. 7 years ago
Jack Humbert 5cab5e4a4e validates json 7 years ago
Jack Humbert d8145c8464 adds redirects for docs 7 years ago
Joe Wasson 94ca84d271 Fix incorrect name for GeminiPR in docs. 7 years ago
Jack Humbert 52f2f6d8ea adds audio docs to summary 7 years ago