Commit Graph

269 Commits (0d98822144975c96f93eb5557924282ad981fa24)

Author SHA1 Message Date
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
Benny Powers 9fed4f7948 Add link to keycodes doc in how_keyboards_work 7 years ago
Roy Wellington Ⅳ c0a6935fb3 Fix these links, as they appear to be broken (#1595)
It looks like build_environment_setup.md got renamed to
getting_started_build_tools.md in this commit:

	commit e6c638bed1
	Author: skullY <skullydazed@gmail.com>
	Date:   Sat Aug 5 20:54:34 2017 -0700

		Overhaul the Getting Started section and add a FAQ section

	 docs/{build_environment_setup.md => getting_started_build_tools.md} | 132 ++++++++++++++++++++++++++++++++++++-------------------------------------

This commit adjusts the links to match the new name.
7 years ago
Jack Humbert b483a90a90 update favicons 7 years ago
skullY f02430b131 Update links in the glossary 7 years ago
skullY 9d1a08e38a Doc updates from going through every file 7 years ago
skullY 9b879b1267 break up keymaps and quantum keycodes into files by feature 7 years ago
skullY 2709744cdd take a stab at documenting layers 7 years ago
skullY 207bcd788a rework key_functions into feature_common_shortcuts 7 years ago
skullY e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 years ago
discursivemoth b7d43ee253 correct tilde to grave 7 years ago
Balz Guenat 430151dd51 Merge remote-tracking branch 'upstream/master'
# Conflicts:
#	docs/faq_keymap.md
7 years ago
Balz Guenat 175db1a549 fix code block formatting 7 years ago
Balz Guenat 5ad103fa51 add description of new option to docs and add option (commented out) into template. 7 years ago
Balz Guenat 3e67cc9c80 add description of new option to docs and add option (commented out) into template. 7 years ago
Danny Nguyen f1536a3f54 Change installation of avr-libc to avr-gcc, now that avr-libc is integrated into the avr-gcc build 7 years ago
Fredric Silberberg a3e1d9a8cc Added support for locking One Shot modifiers. 7 years ago
Fredric Silberberg 5fc4a664dc Added initial key lock documentation. 7 years ago
Jack Humbert 9e79bb1491 Merge pull request #1554 from qmk/docs
Updates some remaining doc stuff
7 years ago
Balz Guenat 525b3deadf add short name for locking mods to docs. 7 years ago
Balz Guenat 07ba06d0b6 fix section in porting guide that refered to Makefile instead of rules.mk 7 years ago
Joe Wasson c5780647d8 Fix typo in docs. 8 years ago
Joe Wasson 26fb063be3 Link to steno docs from summary page. 8 years ago
Joe Wasson c0f63ca9dc Add documentation for Steno. 8 years ago
Jack Humbert cefc09ae7d adds option for alt pitch standards 8 years ago
Joe Wasson a543ad4c1d Fix minor formatting issue. 8 years ago
Jack Humbert 6bdf7482b1 update audio/music documentation 8 years ago
Jack Humbert 9abbbe7089 update audio documentation 8 years ago
Jack Humbert f407f3e8de remove unneccesary headers 8 years ago
Jack Humbert fe113ebad5 start updating audio docs 8 years ago
Jack Humbert 14c5160b1a Update _summary.md 8 years ago
Jack Humbert 000e749853 Rename docs/features/README.md to docs/features.md 8 years ago
Erez Zukerman 585f140052 Invites contributions 8 years ago
skullY 4c7c7747a3 Add terminal examples to doc best practices 8 years ago
skullY 5810bb67e4 Rearrange the faq a bit 8 years ago
skullY cb9e59152e Flesh out the glossary 8 years ago
skullY 03eb6a3e86 comment out unformatted audio/midi sections 8 years ago
skullydazed ecd3dbf085 Merge branch 'master' into docs 8 years ago
cato976 1896c76a29 Update mouse_keys.md
fix typo
8 years ago
Shayne Holmes 48ff93582b Pull out sendstring variations to their own files.
Instead of having all sendstring keycode mappings in the main quantum.c
file, give each one its own file in keymap_extras that can be #included
in a user's keymap. If one is included, it will define the appropriate
lookup tables and overwrite the weak definitions in quantum.c.
(Including more than one sendstring definition will fail at compile
time.)

Update @rai-suta's test keymap to match, as well as the documentation.
8 years ago
skullY 9cadba7b89 Add missing files to _summary.md 8 years ago
skullY f1c581fdd4 Remove obsolete documentation 8 years ago
skullY c12f19107f update the summary 8 years ago
skullY 2abff258b1 Adjust headings on unicode 8 years ago
skullY 0ded95b888 Update the vagrant guide 8 years ago
skullY ff47ca7a46 update hand_wire 8 years ago
skullY dff5708b07 update basic_how_keyboards_work 8 years ago
skullY 435f99916c Work around quoting hell 8 years ago
skullY b22220532f Rewrite mouse_keys to resolve #937 8 years ago
skullY 6b0503b20d update the faq 8 years ago
skullY 80cc23e912 fix the info boxes 8 years ago
skullY d8e29b53fe Update a bunch of docs 8 years ago
skullY ea8df568f2 reduce the TOC scope 8 years ago
skullY 486abde026 tweak page-toc settings 8 years ago
skullY 10b389f79c Adjust headings to make navigator happier 8 years ago
Jack Humbert 3e3c3e2b24 start glossary 8 years ago
Jack Humbert 9f643ba8bf clean-up github page 8 years ago
Jack Humbert 4c7e66c31c add file to summary 8 years ago
Jack Humbert b139633f89 adds how to github 8 years ago
skullY 7da94ac51b Fixup the gitbook config 8 years ago
skullY bf3007ec58 Add some gitboot plugins 8 years ago
skullY 409cb1af52 Polish up custom_quantum_functions 8 years ago
Jack Humbert b75ad215c8 use default base names 8 years ago
Jack Humbert 391eae97e4 testing out new home 8 years ago
Jack Humbert d59734d3b7 restructure summary 8 years ago
skullY 910d32c07e Flesh out the quantum_keycodes documentation 8 years ago
Jack Humbert d5244c6cf4 restructure keycode docs 8 years ago
Jack Humbert 40d82906cb adds config options md 8 years ago
skullY 617923cd56 Rough draft for a document on understanding QMK 8 years ago
Jack Humbert ea7590c894 add new arguements, docs 8 years ago
Jack Humbert 4ba9438c3f Add eclipse to the _summary 8 years ago
Jack Humbert 901a92a2fd Update _summary.md 8 years ago
Jack Humbert c208a6d4e5 update docs for isp 8 years ago
Jack Humbert 918aea5b47 Update _summary.md 8 years ago
Jack Humbert b4f2f44a6f Create isp_flashing_guide.md 8 years ago
Jack Humbert 2b98ec67f3 Update _summary.md 8 years ago
Jack Humbert 7b3c9cc8de Create adding_a_keyboard_to_qmk.md 8 years ago
Jack Humbert f32c68ee65 Update porting_your_keyboard_to_qmk.md 8 years ago
Jack Humbert 621ae42a6c revert edit 8 years ago
Jack Humbert 4217cb5bbc Update key_functions.md 8 years ago
Jack Humbert 6bd4df7a90 define limits to functions 8 years ago
Jack Humbert 06f0f92c1a Delete VAGRANT_GUIDE.md 8 years ago
Jack Humbert 7921834663 Delete USB_NKRO.txt 8 years ago
Jack Humbert d942389e11 Delete TMK_README.md 8 years ago
Jack Humbert 3df614c942 Delete POWER.txt 8 years ago
Jack Humbert 08fdced65f Delete PCB_GUIDE.md 8 years ago
Jack Humbert de4a38ab1b Delete Macros.md 8 years ago
Jack Humbert ceb7a63c68 Delete Kiibohd.asciidoc 8 years ago
Jack Humbert 656744e7dd Delete Keymap.md 8 years ago
Jack Humbert 6442822efd Delete Keycodes.md 8 years ago
Jack Humbert f320ac4bc6 Delete Home.md 8 years ago
Jack Humbert ee595965ae Delete HAND_WIRE.md 8 years ago
Jack Humbert 4de370ccc3 Delete FUSE.txt 8 years ago
Jack Humbert 4092e45b6b Delete FAQ.md 8 years ago
Jack Humbert 296e8669f3 Delete Embedding.md 8 years ago
Jack Humbert fa6044ab1d Delete Eclipse.md 8 years ago
Jack Humbert 401aab7d5a Delete CYGWIN_GUIDE.md 8 years ago
Jack Humbert 5e9d5a0a75 Delete BUILD_GUIDE.md 8 years ago
Jack Humbert 995c3141a6 convert docs to lowercase and underscores 8 years ago
Jack Humbert ca01d94005 convert docs to lowercase and underscores 8 years ago
Jack Humbert 558db0e03f remove leading slash 8 years ago
Jack Humbert 43b6179feb Merge branch 'master' into improve_macro_docs 8 years ago
Jack Humbert 163754f363 Create Home.md 8 years ago
Jack Humbert ad49086be5 Create SUMMARY.md 8 years ago
Jack Humbert 2f942c9883 Create Custom-Quantum-Functions.md 8 years ago
Jack Humbert 1da0a19177 make searchable 8 years ago
Jack Humbert 5801a1f8af update music docs 8 years ago