Jason Milkins
78923cb884
Fix code backticks on Frequently Asked Build Questions docs
2017-10-21 09:58:48 -10:00
Jason Milkins
a860d9d628
Fix missing code backticks
2017-10-21 09:58:17 -10:00
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
2017-10-18 17:14:12 -10:00
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
2017-10-17 16:47:49 -07:00
Dylan Khor
aa660c1eb7
Broken link found in issue #1845
2017-10-15 15:03:23 -10:00
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
2017-10-14 11:32:19 -10:00
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.
2017-10-12 06:25:47 -10:00
skullY
db5afb05cf
Fix the presentation of the contribution guide
2017-10-11 12:18:53 -07:00
skullydazed
2db4ad2133
Write a contributing guide. ( #1827 )
2017-10-11 12:07:15 -07:00
Jesper Brix Rosenkilde
966e2660cf
Add option to reverse PS2 mouse axes and scrolling
2017-10-10 07:20:17 -10:00
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
2017-10-10 07:07:59 -10:00
lyuts
d8c62e4238
Fixed typo in docs. ( #1818 )
2017-10-06 20:15:55 -07:00
Snipeye
ee13228486
Generic Pointing Device ( #1767 )
2017-10-06 07:13:08 -10:00
Dylan Khor
0cc62459a7
Minor typo
2017-10-05 07:22:25 -10:00
Sebastian Kaim
29bcffb3f3
Edited a minor typo in feature_bootmagic.md.
2017-10-05 06:17:34 -10:00
Daniel Gordon
03de0c8575
Reference to rules.mk in tap dance docs added
...
Change-Id: I64aa6f95a30ab05f0ed3f499e54b9e125d379fad
2017-10-03 09:04:31 -10:00
Max Riveiro
f1451b4b04
Fix HSV Color Wheel image on RGB Light page ( #1773 )
...
Signed-off-by: Max Riveiro <kavu13@gmail.com>
2017-09-29 16:19:15 -07:00
Lukas Werling
1ad941e984
Add shell.nix for NixOS users
2017-09-25 13:14:20 -04:00
Zach Burchill
809c9258c1
Fixed typo of "multually" to "mutually"
2017-09-25 13:08:06 -04:00
surlyjake
c8d365f5da
platform descriptions to match master keycodes.md documentation
2017-09-25 13:07:46 -04:00
surlyjake
957e44231a
updated keycodes media descriptions
...
Platform compatibility descriptions added for mute, volume up/down
2017-09-25 13:07:46 -04:00
Jeremy Cowgar
a89183591c
Fixed a few typos and spelling errors in auto shift feature document
2017-09-18 17:08:18 -04:00
Jeremy Cowgar
abba393f57
Added Auto Shift, tap key = normal, hold key = shifted state.
2017-09-18 17:08:18 -04:00
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
2017-09-12 00:43:10 -04:00
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
2017-09-08 13:47:50 -04:00
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
2017-09-06 14:49:19 -07:00
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.
2017-09-06 10:36:47 -07:00
Jack Humbert
5f154f0a00
Update feature_common_shortcuts.md
2017-09-05 13:11:43 -04:00
Marco Fontani
da83f04a30
add UC_OSX_RALT to make unicode use the Right Alt key on OSX
2017-08-30 11:38:03 -04:00
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
2017-08-23 22:29:07 -04:00
Joe Wasson
bdc0880ca5
Add compile error if too many endpoints are defined for the ATmega32U4.
2017-08-20 11:51:57 -04:00
Jack Humbert
5cab5e4a4e
validates json
2017-08-19 08:35:14 -04:00
Jack Humbert
d8145c8464
adds redirects for docs
2017-08-19 08:31:54 -04:00
Joe Wasson
94ca84d271
Fix incorrect name for GeminiPR in docs.
2017-08-18 14:43:24 -04:00
Jack Humbert
52f2f6d8ea
adds audio docs to summary
2017-08-18 13:57:57 -04:00
Benny Powers
9fed4f7948
Add link to keycodes doc in how_keyboards_work
2017-08-18 12:49:55 -04:00
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
2017-08-18 00:18:04 -07:00
Jack Humbert
b483a90a90
update favicons
2017-08-17 17:13:44 -04:00
skullY
f02430b131
Update links in the glossary
2017-08-16 15:47:20 -04:00
skullY
9d1a08e38a
Doc updates from going through every file
2017-08-16 15:47:20 -04:00
skullY
9b879b1267
break up keymaps and quantum keycodes into files by feature
2017-08-16 15:47:20 -04:00
skullY
2709744cdd
take a stab at documenting layers
2017-08-16 15:47:20 -04:00
skullY
207bcd788a
rework key_functions into feature_common_shortcuts
2017-08-16 15:47:20 -04:00
skullY
e6c638bed1
Overhaul the Getting Started section and add a FAQ section
2017-08-16 15:47:20 -04:00
discursivemoth
b7d43ee253
correct tilde to grave
2017-08-15 19:48:58 -04:00
Balz Guenat
430151dd51
Merge remote-tracking branch 'upstream/master'
...
# Conflicts:
# docs/faq_keymap.md
2017-08-12 12:14:33 +02:00
Balz Guenat
175db1a549
fix code block formatting
2017-08-11 23:13:50 +02:00
Balz Guenat
5ad103fa51
add description of new option to docs and add option (commented out) into template.
2017-08-11 16:54:10 -04:00
Balz Guenat
3e67cc9c80
add description of new option to docs and add option (commented out) into template.
2017-08-11 22:20:36 +02:00
Danny Nguyen
f1536a3f54
Change installation of avr-libc to avr-gcc, now that avr-libc is integrated into the avr-gcc build
2017-08-08 10:03:19 -04:00
Fredric Silberberg
a3e1d9a8cc
Added support for locking One Shot modifiers.
2017-08-08 10:02:53 -04:00
Fredric Silberberg
5fc4a664dc
Added initial key lock documentation.
2017-08-08 10:02:53 -04:00
Jack Humbert
9e79bb1491
Merge pull request #1554 from qmk/docs
...
Updates some remaining doc stuff
2017-08-06 22:29:59 -04:00
Balz Guenat
525b3deadf
add short name for locking mods to docs.
2017-08-03 23:10:31 -04:00
Balz Guenat
07ba06d0b6
fix section in porting guide that refered to Makefile instead of rules.mk
2017-08-02 22:00:49 -04:00
Joe Wasson
c5780647d8
Fix typo in docs.
2017-07-27 16:10:36 -04:00
Joe Wasson
26fb063be3
Link to steno docs from summary page.
2017-07-27 16:10:36 -04:00
Joe Wasson
c0f63ca9dc
Add documentation for Steno.
2017-07-27 16:10:36 -04:00
Jack Humbert
cefc09ae7d
adds option for alt pitch standards
2017-07-24 12:45:34 -04:00
Joe Wasson
a543ad4c1d
Fix minor formatting issue.
2017-07-23 15:10:27 -04:00
Jack Humbert
6bdf7482b1
update audio/music documentation
2017-07-23 14:59:29 -04:00
Jack Humbert
9abbbe7089
update audio documentation
2017-07-23 14:59:29 -04:00
Jack Humbert
f407f3e8de
remove unneccesary headers
2017-07-23 14:59:29 -04:00
Jack Humbert
fe113ebad5
start updating audio docs
2017-07-23 14:59:29 -04:00
Jack Humbert
14c5160b1a
Update _summary.md
2017-07-17 15:01:33 -04:00
Jack Humbert
000e749853
Rename docs/features/README.md to docs/features.md
2017-07-17 15:01:11 -04:00
Erez Zukerman
585f140052
Invites contributions
2017-07-10 20:51:46 -04:00
skullY
4c7c7747a3
Add terminal examples to doc best practices
2017-07-08 22:39:17 -07:00
skullY
5810bb67e4
Rearrange the faq a bit
2017-07-08 20:01:35 -07:00
skullY
cb9e59152e
Flesh out the glossary
2017-07-08 20:01:30 -07:00
skullY
03eb6a3e86
comment out unformatted audio/midi sections
2017-07-07 13:28:31 -07:00
skullydazed
ecd3dbf085
Merge branch 'master' into docs
2017-07-06 18:43:22 -07:00
cato976
1896c76a29
Update mouse_keys.md
...
fix typo
2017-07-06 10:01:12 -04:00
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.
2017-07-05 10:55:47 -04:00
skullY
9cadba7b89
Add missing files to _summary.md
2017-07-03 12:39:15 -07:00
skullY
f1c581fdd4
Remove obsolete documentation
2017-07-03 12:31:37 -07:00
skullY
c12f19107f
update the summary
2017-07-03 12:30:26 -07:00
skullY
2abff258b1
Adjust headings on unicode
2017-07-03 12:29:04 -07:00
skullY
0ded95b888
Update the vagrant guide
2017-07-03 12:28:48 -07:00
skullY
ff47ca7a46
update hand_wire
2017-07-03 12:11:13 -07:00
skullY
dff5708b07
update basic_how_keyboards_work
2017-07-03 11:59:19 -07:00
skullY
435f99916c
Work around quoting hell
2017-07-03 11:35:29 -07:00
skullY
b22220532f
Rewrite mouse_keys to resolve #937
2017-07-03 10:58:57 -07:00
skullY
6b0503b20d
update the faq
2017-07-03 01:37:05 -07:00
skullY
80cc23e912
fix the info boxes
2017-07-03 01:33:13 -07:00
skullY
d8e29b53fe
Update a bunch of docs
2017-07-03 01:30:36 -07:00
skullY
ea8df568f2
reduce the TOC scope
2017-06-30 10:13:25 -07:00
skullY
486abde026
tweak page-toc settings
2017-06-30 10:06:40 -07:00
skullY
10b389f79c
Adjust headings to make navigator happier
2017-06-30 09:42:38 -07:00
Jack Humbert
3e3c3e2b24
start glossary
2017-06-29 22:12:24 -04:00
Jack Humbert
9f643ba8bf
clean-up github page
2017-06-29 21:23:20 -04:00
Jack Humbert
4c7e66c31c
add file to summary
2017-06-29 19:37:49 -04:00
Jack Humbert
b139633f89
adds how to github
2017-06-29 19:35:33 -04:00
skullY
7da94ac51b
Fixup the gitbook config
2017-06-29 17:14:01 -04:00
skullY
bf3007ec58
Add some gitboot plugins
2017-06-29 11:46:58 -07:00
skullY
409cb1af52
Polish up custom_quantum_functions
2017-06-29 10:46:23 -07:00
Jack Humbert
b75ad215c8
use default base names
2017-06-29 12:25:29 -04:00
Jack Humbert
391eae97e4
testing out new home
2017-06-29 12:13:44 -04:00
Jack Humbert
d59734d3b7
restructure summary
2017-06-29 10:35:09 -04:00
skullY
910d32c07e
Flesh out the quantum_keycodes documentation
2017-06-28 23:52:08 -07:00
Jack Humbert
d5244c6cf4
restructure keycode docs
2017-06-29 00:15:07 -04:00
Jack Humbert
40d82906cb
adds config options md
2017-06-28 21:20:23 -04:00
skullY
617923cd56
Rough draft for a document on understanding QMK
2017-06-28 20:22:37 -04:00
Jack Humbert
ea7590c894
add new arguements, docs
2017-06-27 14:35:08 -04:00
Jack Humbert
4ba9438c3f
Add eclipse to the _summary
2017-06-27 13:07:50 -04:00
Jack Humbert
901a92a2fd
Update _summary.md
2017-06-24 13:11:25 -04:00
Jack Humbert
c208a6d4e5
update docs for isp
2017-06-23 23:09:14 -04:00
Jack Humbert
918aea5b47
Update _summary.md
2017-06-23 21:29:35 -04:00
Jack Humbert
b4f2f44a6f
Create isp_flashing_guide.md
2017-06-23 21:29:04 -04:00
Jack Humbert
2b98ec67f3
Update _summary.md
2017-06-22 13:23:08 -04:00
Jack Humbert
7b3c9cc8de
Create adding_a_keyboard_to_qmk.md
2017-06-22 13:22:21 -04:00
Jack Humbert
f32c68ee65
Update porting_your_keyboard_to_qmk.md
2017-06-22 13:21:43 -04:00
Jack Humbert
621ae42a6c
revert edit
2017-06-18 13:28:34 -04:00
Jack Humbert
4217cb5bbc
Update key_functions.md
2017-06-18 13:26:20 -04:00
Jack Humbert
6bd4df7a90
define limits to functions
2017-06-11 14:28:30 -04:00
Jack Humbert
06f0f92c1a
Delete VAGRANT_GUIDE.md
2017-06-10 15:13:24 -04:00
Jack Humbert
7921834663
Delete USB_NKRO.txt
2017-06-10 15:13:15 -04:00
Jack Humbert
d942389e11
Delete TMK_README.md
2017-06-10 15:13:07 -04:00
Jack Humbert
3df614c942
Delete POWER.txt
2017-06-10 15:12:59 -04:00
Jack Humbert
08fdced65f
Delete PCB_GUIDE.md
2017-06-10 15:12:52 -04:00
Jack Humbert
de4a38ab1b
Delete Macros.md
2017-06-10 15:12:45 -04:00
Jack Humbert
ceb7a63c68
Delete Kiibohd.asciidoc
2017-06-10 15:12:39 -04:00
Jack Humbert
656744e7dd
Delete Keymap.md
2017-06-10 15:12:32 -04:00
Jack Humbert
6442822efd
Delete Keycodes.md
2017-06-10 15:12:20 -04:00
Jack Humbert
f320ac4bc6
Delete Home.md
2017-06-10 15:12:12 -04:00
Jack Humbert
ee595965ae
Delete HAND_WIRE.md
2017-06-10 15:12:04 -04:00
Jack Humbert
4de370ccc3
Delete FUSE.txt
2017-06-10 15:11:53 -04:00
Jack Humbert
4092e45b6b
Delete FAQ.md
2017-06-10 15:11:36 -04:00
Jack Humbert
296e8669f3
Delete Embedding.md
2017-06-10 15:11:26 -04:00
Jack Humbert
fa6044ab1d
Delete Eclipse.md
2017-06-10 15:11:18 -04:00
Jack Humbert
401aab7d5a
Delete CYGWIN_GUIDE.md
2017-06-10 15:11:02 -04:00
Jack Humbert
5e9d5a0a75
Delete BUILD_GUIDE.md
2017-06-10 15:10:44 -04:00
Jack Humbert
995c3141a6
convert docs to lowercase and underscores
2017-06-10 14:58:55 -04:00
Jack Humbert
ca01d94005
convert docs to lowercase and underscores
2017-06-10 14:58:24 -04:00
Jack Humbert
558db0e03f
remove leading slash
2017-06-10 12:28:37 -04:00
Jack Humbert
43b6179feb
Merge branch 'master' into improve_macro_docs
2017-06-10 12:26:57 -04:00
Jack Humbert
163754f363
Create Home.md
2017-06-10 12:26:09 -04:00
Jack Humbert
ad49086be5
Create SUMMARY.md
2017-06-10 12:25:04 -04:00
Jack Humbert
2f942c9883
Create Custom-Quantum-Functions.md
2017-06-10 12:23:04 -04:00
Jack Humbert
1da0a19177
make searchable
2017-06-10 12:18:49 -04:00
Jack Humbert
5801a1f8af
update music docs
2017-06-09 16:42:30 -04:00
skullY
a0ac0d3cea
Move Dynamic Macros into their own file
2017-06-09 12:25:12 -07:00
skullY
767bcac23c
Clean up and improve the macro documentation
2017-06-09 11:47:53 -07:00
Ethan Madden
d9f95c5da9
Docfix ( #1377 )
...
* SCKLCK is now SCROLLLOCK
Yes, with all three Ls
At least it doesn't have a random K anymore lol
* Removed strange mystery trailing numbers in the docs
2017-06-08 20:05:55 -07:00
Erez Zukerman
481797f92f
Documents permissive hold
2017-06-08 23:00:28 -04:00
Ethan Madden
e82c089b4c
SCKLCK is now SCROLLLOCK ( #1376 )
...
Yes, with all three Ls
At least it doesn't have a random K anymore lol
2017-06-08 19:54:49 -07:00
Jack Humbert
eefec19ad9
Update Keycodes.md
2017-06-02 09:44:08 -04:00
Jack Humbert
47c209fa02
Update Keycodes.md
2017-06-02 09:21:01 -04:00
fabienheureux
19816a4998
Broken Keymap docs link
2017-06-02 10:51:12 +02:00
Jack Humbert
1d6a18db99
Merge pull request #1343 from Maartenwut/patch-1
...
Added SEND_STRING(); to the documentation.
2017-05-29 11:58:08 -04:00
