Jack Humbert
6 years ago
6 changed files with 25 additions and 101 deletions
Split View
Diff Options
-
+0 -18quantum/template/Makefile
-
+1 -1quantum/template/config.h
-
+0 -37quantum/template/keymaps/default/Makefile
-
+1 -1quantum/template/keymaps/default/config.h
-
+9 -30quantum/template/readme.md
-
+14 -14quantum/template/rules.mk
+ 0
- 18
quantum/template/Makefile
View File
| @ -1,18 +0,0 @@ | |||
| # Copyright 2013 Jun Wako <wakojun@gmail.com> | |||
| # | |||
| # This program is free software: you can redistribute it and/or modify | |||
| # it under the terms of the GNU General Public License as published by | |||
| # the Free Software Foundation, either version 2 of the License, or | |||
| # (at your option) any later version. | |||
| # | |||
| # This program is distributed in the hope that it will be useful, | |||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| # GNU General Public License for more details. | |||
| # | |||
| # You should have received a copy of the GNU General Public License | |||
| # along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| ifndef MAKEFILE_INCLUDED | |||
| include ../../Makefile | |||
| endif | |||
+ 1
- 1
quantum/template/config.h
View File
+ 0
- 37
quantum/template/keymaps/default/Makefile
View File
| @ -1,37 +0,0 @@ | |||
| # Copyright 2013 Jun Wako <wakojun@gmail.com> | |||
| # | |||
| # This program is free software: you can redistribute it and/or modify | |||
| # it under the terms of the GNU General Public License as published by | |||
| # the Free Software Foundation, either version 2 of the License, or | |||
| # (at your option) any later version. | |||
| # | |||
| # This program is distributed in the hope that it will be useful, | |||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| # GNU General Public License for more details. | |||
| # | |||
| # You should have received a copy of the GNU General Public License | |||
| # along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| # QMK Build Options | |||
| # change to "no" to disable the options, or define them in the Makefile in | |||
| # the appropriate keymap folder that will get included automatically | |||
| # | |||
| BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) | |||
| MOUSEKEY_ENABLE = yes # Mouse keys(+4700) | |||
| EXTRAKEY_ENABLE = yes # Audio control and System control(+450) | |||
| CONSOLE_ENABLE = no # Console for debug(+400) | |||
| COMMAND_ENABLE = yes # Commands for debug and configuration | |||
| NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | |||
| BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality | |||
| MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config) | |||
| AUDIO_ENABLE = no # Audio output on port C6 | |||
| UNICODE_ENABLE = no # Unicode | |||
| BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID | |||
| RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. Do not enable this with audio at the same time. | |||
| SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | |||
| ifndef QUANTUM_DIR | |||
| include ../../../../Makefile | |||
| endif | |||
+ 1
- 1
quantum/template/keymaps/default/config.h
View File
+ 9
- 30
quantum/template/readme.md
View File
| @ -1,36 +1,15 @@ | |||
| %KEYBOARD% keyboard firmware | |||
| ====================== | |||
| # %KEYBOARD% | |||
| ## Quantum MK Firmware | |||
|  | |||
| For the full Quantum feature list, see [the parent readme](/). | |||
| A short description of the keyboard/project | |||
| ## Building | |||
| Keyboard Maintainer: [You](https://github.com/yourusername) | |||
| Hardware Supported: The PCBs, controllers supported | |||
| Hardware Availability: links to where you can find this hardware | |||
| Download or clone the whole firmware and navigate to the root folder. Once your dev env is setup, you'll be able to type `make %KEYBOARD%-default` to generate your .hex - you can then use the Teensy Loader to program your .hex file. | |||
| Make example for this keyboard (after setting up your build environment): | |||
| (Note: replace %KEYBOARD% with the name of your keyboard.) | |||
| make planck/rev4:default | |||
| Depending on which keymap you would like to use, you will have to compile slightly differently. | |||
| ### Default | |||
| To build with the default keymap, simply run `make %KEYBOARD%-default`. | |||
| ### Other Keymaps | |||
| Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder. Create a `readme.md` and a `keymap.c` file to complete your new keymap. When you are done your file tree should look like this: | |||
| * `qmk_firmware/` | |||
| * `keyboard/` | |||
| * `keymaps/` | |||
| * `config.h` (optional) | |||
| * `keymap.c` | |||
| * `readme.md` | |||
| * `rules.mk` (optional) | |||
| To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | |||
| ``` | |||
| $ make %KEYBOARD%-[default|jack|<name>] | |||
| ``` | |||
| See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. | |||