summaryrefslogtreecommitdiffstats
path: root/docs/getting_started_make_guide.md
Commit message (Collapse)AuthorAgeFilesLines
* Add docs for 'CUSTOM_MATRIX = lite' (#7906)Joel Challis2020-01-181-1/+1
| | | | | | | | | | | | | | | | * Add some docs to cover 'CUSTOM_MATRIX = lite' * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> * Add 'SRC += matrix.c' docs * Update docs/custom_matrix.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
* Update getting_started_make_guide.md (#7538)arlenk2019-12-061-1/+1
| | | | | | | | | | * Update getting_started_make_guide.md clarifying that NO_PRINT and USER_PRINT should not be used at the same time. * Update docs/getting_started_make_guide.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
* [Docs] Update flashing information to include :flash target (#6999)Drashna Jaelre2019-10-291-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update Newbs Flashing guide For the newbs that want to start flashing * Update flashing docs * Misc flashing * Attempt at flashing in french Lets hope I didn't butcher this too badly with machine transations * Update docs/feature_userspace.md * Apply language suggestions from code review * Apply suggestions from code review * Apply additional fr lang suggestions from code review * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch> Co-Authored-By: Xavier Hahn <xavier.hahn@gmail.com> Co-Authored-By: Vincent LE GOFF <vince.legoff@gmail.com>
* Remove build option firmware size impacts (#6947)Amber Holly2019-10-181-7/+1
| | | | | | | | | | | | | | | | | | | | | | * Update rules.mk template to remove build option size impacts * Add rules.mk cleaning script * Update all rules.mk files to remove build option firmware size impact messages * Remove references to feature filesize in documentation * Revert "Update all rules.mk files to remove build option firmware size impact messages" This reverts commit 7cfe70976bcc223bf47c960b2e6af8596df80a32. * Fix regex in cleanup script and exclude keymaps/ directories * Update quantum/template/avr/rules.mk Fixed missing tabs/spaces. Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Add 'bootloadHID' flash target (#5587)Joel Challis2019-08-241-1/+1
| | | | | | | | | | | | | | * Add 'bootloadHID' flash target * Prep for flash target * Add :flash support * Align bootloader wait messages Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update template to suggest use of :flash
* Improve backlight PWM pin support (#6202)fauxpark2019-08-081-1/+1
| | | | | | | | | | | | | | | | * Improve backlight PWM pin support * I accidentally an equals sign * Another typo * Order by pin number * Throw an error if backlight pin is C4 or C5 on 16/32U4 * Use else for clarity * Minor alignment adjustments
* Clean up debounce a bit (#5255)James Churchill2019-03-041-2/+2
|
* Simplify split_common Code significantly (#4772)James Churchill2019-01-171-1/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Eliminate separate slave loop Both master and slave run the standard keyboard_task main loop now. * Refactor i2c/serial specific code Simplify some of the preprocessor mess by using common function names. * Fix missing #endif * Move direct pin mapping support from miniaxe to split_common For boards with more pins than sense--sorry, switches. * Reordering and reformatting only * Don't run matrix_scan_quantum on slave side * Clean up the offset/slaveOffset calculations * Cut undebounced matrix size in half * Refactor debouncing * Minor fixups * Split split_common transport and debounce code into their own files Can now be replaced with custom versions per keyboard using CUSTOM_TRANSPORT = yes and CUSTOM_DEBOUNCE = yes * Refactor debounce for non-split keyboards too * Update handwired/xealous to build using new split_common * Fix debounce breaking basic test * Dodgy method to allow a split kb to only include one of i2c/serial SPLIT_TRANSPORT = serial or SPLIT_TRANSPORT = i2c will include only that driver code in the binary. SPLIT_TRANSPORT = custom (or anything else) will include neither, the keyboard must supply it's own code if SPLIT_TRANSPORT is not defined then the original behaviour (include both avr i2c and serial code) is maintained. This could be better but it would require explicitly updating all the existing split keyboards. * Enable LTO to get lets_split/sockets under the line * Add docs for SPLIT_TRANSPORT, CUSTOM_MATRIX, CUSTOM_DEBOUNCE * Remove avr-specific sei() from split matrix_setup Not needed now that slave doesn't have a separate main loop. Both sides (on avr) call sei() in lufa's main() after exiting keyboard_setup(). * Fix QUANTUM_LIB_SRC references and simplify SPLIT_TRANSPORT. * Add comments and fix formatting.
* Improve consistency in UNICODEMAP code and docs, update ↵Konstantin Đorđević2019-01-071-9/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | docs/understanding_qmk (#4774) * Remove unused UNICODE(n) macro, update docs * Add note about max length of unicode_map to docs * QK_UNICODE_MAP → QK_UNICODEMAP * Refactor process_unicode_map * process_unicode_map → process_unicodemap This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself. * Update references and ordering in docs/understanding_qmk * Add additional note to docs/understanding_qmk * &unicode_map[index] → unicode_map + index This avoids the issue of the compiler sometimes complaining about the array index being out of range * Update docs/getting_started_make_guide * Update method sections in docs/feature_unicode
* Lets split eh (#3120)That-Canadian2018-07-161-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Line ending stuff again * Added Let's Split Eh? Files and updated #USE_IC2 checks to also include th EH revision (can only be used in I2C) * Added personal keymap, updated some of the EH files * Created new keyboard file for testing "lets_split_eh" will merge into lets_split once fully functional * Added split code from lets_split, removed pro micro imports and LED code THIS IS WORKING CODE, WITHOUT RGB AND BACKLIGHT * Took back original Lets Slit files for the lets_split keyboard, working in the lets_split_eh folder for now * Updated eh.c * More rework of the I2C code, added global flags for split boards. * Introduced RGB over I2C, having weird edge case issues at the moment though * Fixed weird I2C edgecase with RGB, although still would like to track down route cause.. * Changed RGB keycodes (static ones) to activate on key-up instead of key-down to elimate weird ghosting issue over I2C * Lots of changes, mainly externalized the Split keyboard code and added logic for only including when needed. - Added makefile option "SPLIT_KEYBOARD" that when = yes will include the split keyboard files and custom matrix - Split keyboard files placed into quantum/split_common/ - Added define option for config files "SPLIT_HAND_PIN" FOr using high/low pin to determine handedness, low = right hand, high = left hand - Cleaned up split logic for RGB and Backlight so it is only exectuted / included when needed * Updated documentation for the new makefile options and #defines specific to split keyboards * Added a bit more info to docs, so people aren't confused * Modifed Let's Split to use externalized code, also added left and right hand eeprom files to the split_common folder * Removed some debugging from eh.c * Small changes to keyboard configs. Also added a default keymap (just a copy of my that_canadian keymap). * Added a README file to the Let's Split Eh? * Changed it so RGB static updates are done on key-up ONLY for split boards rather than all boards. Also fixed leftover un-used variable in rgblight.c * Updated default keymap and my keymap for Let's Split Eh? Updated the comments so it reflects RGB control, and removed audio functions. * Fixed lets_split_eh not having a default version * Removed "eh" references from lets_split folder for now * Took lets_split folder from master to fix travis build errors, weird my local was overriding. * Changed LAYOUT_ortho_4x12_kc -> LAYOUT_kc_ortho_4x12 to match bakingpy and others * Removed rules.mk from my lets_split keymap, not needed * Updated the config_options doc to better explain the usage of "#define SPLIT_HAND_PIN"
* Added propper support for Lets split vitamins (#2559)Mikkel Jeppesen2018-05-091-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added support for the upcomming Lets_split vitamins included * Updated readme * Corrected header of readme * Enabled RGB * Broke everything * broke some more shit * Revert "broke some more shit" This reverts commit 6ad68e6269cc0d04c16564ce9598dfd3db1e23c1. * Revert "Broke everything" This reverts commit feeee4e40db15a726f2292b6a9406ef45c1e54a7. * Fixed USB detection, and RGB on slave * started modifying readme, to use msys2 * Added support for the upcomming Lets_split vitamins included * Updated readme * Corrected header of readme * Enabled RGB * Broke everything * broke some more shit * Revert "broke some more shit" This reverts commit 6ad68e6269cc0d04c16564ce9598dfd3db1e23c1. * Revert "Broke everything" This reverts commit feeee4e40db15a726f2292b6a9406ef45c1e54a7. * Fixed USB detection, and RGB on slave * started modifying readme, to use msys2 * Updated readme to reflect use of msys2 Added avrdude to msys path * added avrdude option to msys installer * Removed extra installation of avrdude * Renamed to vitamins_included and implemented drashnas changes * Fixed include guard * Fixed some includes, and added avrdude target to docs. * Fixed default keyboard
* Trim trailing whitespacefauxpark2017-12-091-6/+6
|
* Convert all headings to Title Casefauxpark2017-12-091-3/+3
|
* Fix typo in make exampleDrashna Jaelre2017-12-041-1/+1
| | | It has `:all" when it clearly is referencing the command without `:all`.
* Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed2017-10-241-1/+1
| | | | | | * fix #1313 by documenting more config.h options * Clean up and organize documentation
* Make arguments redo, subproject elimination (#1784)Jack Humbert2017-10-141-14/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Remove reference to Ergodox subprojects from docsJonathan Arnett2017-10-121-1/+1
| | | | | | | 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.
* Remove all Makefiles from the keyboards directory. (#1660)skullydazed2017-09-081-39/+9
| | | | | | | | | | | | | | | | | | | | | | * 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
* Doc updates from going through every fileskullY2017-08-161-3/+3
|
* Overhaul the Getting Started section and add a FAQ sectionskullY2017-08-161-0/+171