mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-11-22 00:16:41 +06:00
[Keyboard] move g heavy industry boards into /gboards (#16040)
Co-authored-by: zvecr <git@zvecr.com>
This commit is contained in:
peepeetee
GitHub
parent
52d6f07a82
commit
17c0ca6fa4
|
|
@ -9,6 +9,6 @@ Hardware Availability: [g Heavy Industries](https://www.gboards.ca/product/butte
|
||||||
|
|
||||||
Make example for this keyboard (after setting up your build environment):
|
Make example for this keyboard (after setting up your build environment):
|
||||||
|
|
||||||
make butterstick:default
|
make gboards/butterstick:default
|
||||||
|
|
||||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
This is the default keymap for the ErgoTaco, Make it your own!
|
This is the default keymap for the ErgoTaco, Make it your own!
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/ergotaco/keymaps/default/rules.mk
|
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gboards/ergotaco/keymaps/default/rules.mk
|
||||||
|
|
||||||
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
||||||
|
|
@ -11,13 +11,13 @@ Hardware Availability: [gboards.ca](http://gboards.ca)
|
||||||
## Firmware building
|
## Firmware building
|
||||||
Clone the QMK Repo and install dfu-programmer, flash with:
|
Clone the QMK Repo and install dfu-programmer, flash with:
|
||||||
|
|
||||||
make ergotaco:default:dfu
|
make gboards/ergotaco:default:dfu
|
||||||
|
|
||||||
And reset your keyboard!
|
And reset your keyboard!
|
||||||
|
|
||||||
To just test if your build system is sane, try compiling the default keymap using:
|
To just test if your build system is sane, try compiling the default keymap using:
|
||||||
|
|
||||||
make ergotaco:default
|
make gboards/ergotaco:default
|
||||||
|
|
||||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||||
|
|
||||||
|
|
@ -13,13 +13,13 @@ Hardware Availability: [gboards.ca](http://gboards.ca)
|
||||||
## Firmware building
|
## Firmware building
|
||||||
After cloning the QMK repo and installing dfu-programmer build and flash with. Be sure to reset your keyboard!
|
After cloning the QMK repo and installing dfu-programmer build and flash with. Be sure to reset your keyboard!
|
||||||
|
|
||||||
make georgi:default:dfu
|
make gboards/georgi:default:dfu
|
||||||
|
|
||||||
To just test your build with the default keymap
|
To just test your build with the default keymap
|
||||||
|
|
||||||
make georgi:default
|
make gboards/georgi:default
|
||||||
|
|
||||||
Build options can be enabled/disabled in keyboards/georgi/keymaps/default/rules.mk . Copy the default directory and make any changes to your layout, if you think they're worth sharing submit a PR!
|
Build options can be enabled/disabled in keyboards/gboards/georgi/keymaps/default/rules.mk . Copy the default directory and make any changes to your layout, if you think they're worth sharing submit a PR!
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
Is hosted over on [docs.gboards.ca](http://docs.gboards.ca/). Please take a look at the docs for customizing your firmware!
|
Is hosted over on [docs.gboards.ca](http://docs.gboards.ca/). Please take a look at the docs for customizing your firmware!
|
||||||
|
|
@ -5,6 +5,6 @@
|
||||||
This is my personal modification to the stock gergo keymap.
|
This is my personal modification to the stock gergo keymap.
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gergo/keymaps/default/rules.mk
|
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gboards/gergo/keymaps/default/rules.mk
|
||||||
|
|
||||||
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
||||||
|
|
@ -11,6 +11,6 @@ You can view this layout over at
|
||||||
[keyboad-layout-editor.com](http://www.keyboard-layout-editor.com/#/gists/f04d6a3b0cd3db91407c51f7ba36aeb3).
|
[keyboad-layout-editor.com](http://www.keyboard-layout-editor.com/#/gists/f04d6a3b0cd3db91407c51f7ba36aeb3).
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gergo/keymaps/default/rules.mk
|
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gboards/gergo/keymaps/default/rules.mk
|
||||||
|
|
||||||
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
||||||
|
|
@ -5,6 +5,6 @@
|
||||||
This is the default keymap for Gergo, it's based heavily off of the naps62 ErgoDox layout and is aimed at a programmer friendly keymap.
|
This is the default keymap for Gergo, it's based heavily off of the naps62 ErgoDox layout and is aimed at a programmer friendly keymap.
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gergo/keymaps/default/rules.mk
|
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gboards/gergo/keymaps/default/rules.mk
|
||||||
|
|
||||||
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
||||||
|
|
@ -5,6 +5,6 @@
|
||||||
This is the default keymap for Gergo, it's based heavily off of the naps62 ErgoDox layout and is aimed at a programmer friendly keymap.
|
This is the default keymap for Gergo, it's based heavily off of the naps62 ErgoDox layout and is aimed at a programmer friendly keymap.
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gergo/keymaps/default/rules.mk
|
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gboards/gergo/keymaps/default/rules.mk
|
||||||
|
|
||||||
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
||||||
4
keyboards/gboards/gergo/keymaps/oled/config.h
Normal file
4
keyboards/gboards/gergo/keymaps/oled/config.h
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#define IGNORE_MOD_TAP_INTERRUPT
|
||||||
|
#define OLED_FONT_H "keyboards/gboards/gergo/keymaps/oled/glcdfont.c"
|
||||||
|
|
@ -5,6 +5,6 @@
|
||||||
This is the default keymap for Gergo, it's based heavily off of the naps62 ErgoDox layout and is aimed at a programmer friendly keymap.
|
This is the default keymap for Gergo, it's based heavily off of the naps62 ErgoDox layout and is aimed at a programmer friendly keymap.
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gergo/keymaps/default/rules.mk
|
To edit various settings, enable the 1u trackball and whatnot please modify /keyboards/gboards/gergo/keymaps/default/rules.mk
|
||||||
|
|
||||||
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
Ideally you should copy this directory and make your changes there. If you come up with a good layout submit a PR!
|
||||||
|
|
@ -13,13 +13,13 @@ Hardware Availability: [gboards.ca](http://gboards.ca)
|
||||||
## Firmware building
|
## Firmware building
|
||||||
After cloning the QMK repo and installing dfu-programmer build and flash with. Be sure to reset your keyboard!
|
After cloning the QMK repo and installing dfu-programmer build and flash with. Be sure to reset your keyboard!
|
||||||
|
|
||||||
make gergo:germ:dfu
|
make gboards/gergo:germ:dfu
|
||||||
|
|
||||||
To just test your build with the default keymap
|
To just test your build with the default keymap
|
||||||
|
|
||||||
make gergo:germ
|
make gboards/gergo:germ
|
||||||
|
|
||||||
Gadgets and options can be enabled/disabled in keyboards/gergo/keymaps/default/rules.mk . Copy the default directory and make any changes to your layout, if you think they're worth sharing submit a PR!
|
Gadgets and options can be enabled/disabled in keyboards/gboards/gergo/keymaps/default/rules.mk . Copy the default directory and make any changes to your layout, if you think they're worth sharing submit a PR!
|
||||||
|
|
||||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||||
|
|
||||||
|
|
@ -22,11 +22,11 @@ multi-chords! You can browse the available combo lists in combos/
|
||||||
|
|
||||||
## Engine
|
## Engine
|
||||||
This is the onboard chording engine for all sorts of fun shenanigans. Be aware that this currently is a bit of a QMK
|
This is the onboard chording engine for all sorts of fun shenanigans. Be aware that this currently is a bit of a QMK
|
||||||
replacement focused on pure chording. Take a look at the configuration in keyboards/ginny for ideas, all these dicts
|
replacement focused on pure chording. Take a look at the configuration in keyboards/gboards/ginny for ideas, all these dicts
|
||||||
are stored over in dicts/
|
are stored over in dicts/
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
You will need to add the following bits to your rules.mk, refer to keyboards/ginny for a working example
|
You will need to add the following bits to your rules.mk, refer to keyboards/gboards/ginny for a working example
|
||||||
`VPATH += keyboards/gboards/`
|
`VPATH += keyboards/gboards/`
|
||||||
|
|
||||||
And if you're using the chording engine, this as well.
|
And if you're using the chording engine, this as well.
|
||||||
|
|
@ -35,5 +35,5 @@ And if you're using the chording engine, this as well.
|
||||||
For combos, add `#include "g/keymap_combos.h"` to keymap.c to compile your combos.def into your keymap
|
For combos, add `#include "g/keymap_combos.h"` to keymap.c to compile your combos.def into your keymap
|
||||||
|
|
||||||
For the chording engine, add `#include "g/keymap_engine.h"` to keymap.c compile your dicts.def into your keymap. If you
|
For the chording engine, add `#include "g/keymap_engine.h"` to keymap.c compile your dicts.def into your keymap. If you
|
||||||
don't have a config_engine.h file for your keyboard, you will need to create it. (Once again, look at keyboards/ginny/
|
don't have a config_engine.h file for your keyboard, you will need to create it. (Once again, look at keyboards/gboards/ginny/
|
||||||
for a example of how to do this.
|
for a example of how to do this.
|
||||||
|
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#define IGNORE_MOD_TAP_INTERRUPT
|
|
||||||
#define OLED_FONT_H "keyboards/gergo/keymaps/oled/glcdfont.c"
|
|
||||||
Loading…
Reference in New Issue
Block a user