Commit Graph

20 Commits

Author SHA1 Message Date
fauxpark
9ea9806d67 Set up language fallback for docs, and update translation guidelines ()
* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme
2019-11-23 16:07:15 +00:00
fauxpark
3e22af92ee [Docs] Add an important note about modifying user code ()
* Add an important note about modifying user code

* Update docs/contributing.md

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-10-07 14:50:10 -07:00
skullydazed
a25dd58bc5
QMK CLI and JSON keymap support ()
* Script to generate keymap.c from JSON file.

* Support for keymap.json

* Add a warning about the keymap.c getting overwritten.

* Fix keymap generating

* Install the python deps

* Flesh out more of the python environment

* Remove defunct json2keymap

* Style everything with yapf

* Polish up python support

* Hide json keymap.c into the .build dir

* Polish up qmk-compile-json

* Make milc work with positional arguments

* Fix a couple small things

* Fix some errors and make the CLI more understandable

* Make the qmk wrapper more robust

* Add basic QMK Doctor

* Clean up docstrings and flesh them out as needed

* remove unused compile_firmware() function
2019-07-15 12:14:27 -07:00
skullydazed
068571b9fe
Update our style guide ()
* Update our style guide

* Clarify muiltple condition ifs

* update the ifdef section
2019-04-18 15:59:51 -07:00
Dusty Pomerleau
6d4f6f3f49 [Docs] Add Tap Dance example to the docs ()
* add a tapdance example for creating advanced mod-tap and layer-tap keys

* add optional curly braces to match QMK conventions

* change example to use `register_code16()` and tapdance keycodes more closely matching QMK variants
2019-03-07 12:30:02 -08:00
fauxpark
0d936b2fe6 Ask for your name when generating a new keyboard ()
* Ask for your name when generating a new keyboard

* Update docs

* Apply suggestions from code review

Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-02-26 07:59:34 -08:00
James Churchill
dc5933aff7 Add clang-format section to contributing.md 2019-02-17 08:59:19 -08:00
Drashna Jaelre
7458ac9489 Update Contrib doc ()
* Add link for style

* ignore java

* Add example and update link?

* Minor fixes

* Change 1TBS text

* comments
2018-10-06 20:43:37 -04:00
James Laird-Wah
b1f11636c6 docs/contributing: add #pragma once to Coding Conventions
This supersedes the older include guard mechanism since all the
compilers now support it. It's easier for new users and less prone
to error.
2018-09-15 09:37:06 -07:00
Fred Silberberg
48913153c3 Replace gitter links with Discord. () 2018-07-11 00:01:56 -07:00
Alexander Dang-Tran
73ddb764cc Fix readme and contributing hyperlinks 2018-05-24 00:00:20 -04:00
fauxpark
bb53635f33 Trim trailing whitespace 2017-12-09 10:46:11 -05:00
fauxpark
af37bb2f78 Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
fauxpark
7b0356d1d4 Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
Devin J. Pohly
7aaef16266 Fix internal links in docs/ ()
One link in the summary (Modding your keyboard) referred to a page that
was deleted; the rest have been updated to point to the new names.
2017-11-30 10:18:01 -08:00
Jack Humbert
00733f4b87 update contributing guidelines 2017-11-01 21:42:05 -04:00
skullydazed
67cc5cebc0 Restructure the hardware and feature docs to make things easier to find ()
* fix  by documenting more config.h options

* Clean up and organize documentation
2017-10-24 20:34:28 -07:00
skullY
9bb259b660 Fix the naming for clueboard files 2017-10-21 13:51:18 -07:00
Jack Humbert
800ec55dfc Make arguments redo, subproject elimination ()
* 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
skullY
db5afb05cf Fix the presentation of the contribution guide 2017-10-11 12:18:53 -07:00