summaryrefslogtreecommitdiff
path: root/keyboards/rocketboard_16/readme.md
diff options
context:
space:
mode:
authorSeth <fl3tching101@gmail.com>2020-11-01 12:46:00 -0600
committerGitHub <noreply@github.com>2020-11-01 10:46:00 -0800
commit9f0dbc21a3bcb815877e321c974c55c5320605c6 (patch)
tree5ec4ec1df71d2912600ee6e81eb2aea78b0210cc /keyboards/rocketboard_16/readme.md
parentc731432765c17a159fd83f859a148c861769fd35 (diff)
[Keyboard] beta support for the Rocketboard-16 macro/num pad (#10688)
* Firmware initial commit, still has a few bugs - mainly rotary encoders do not work and needs cleaning up * Fixed the volume control issue and limited the RGB brightness (can be really bright), added the ability to switch LED mode with left encoder click, and added via support (untested) * Remove define that should go in config.h * Removed define that should be in config.h * Removed LTO_ENABLE as suggested - has issues on ARM Co-authored-by: Drashna Jaelre <drashna@live.com> * Added the correct define for OLED screen size * Applied suggested change to remove description Co-authored-by: Ryan <fauxpark@gmail.com> * Made suggested change to remove backslashes Co-authored-by: Ryan <fauxpark@gmail.com> * Suggested change made to rgblight Co-authored-by: Ryan <fauxpark@gmail.com> * Suggested change made to rgblight Co-authored-by: Ryan <fauxpark@gmail.com> * Suggested change made to remove backslashes Co-authored-by: Ryan <fauxpark@gmail.com> * Suggested change made to rgblight Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/rocketboard_16/rocketboard_16.c Co-authored-by: Ryan <fauxpark@gmail.com> * Added suggested comments Co-authored-by: Ryan <fauxpark@gmail.com> * Made suggested changes to rules file Co-authored-by: Ryan <fauxpark@gmail.com> * Added suggested change to rgblight Co-authored-by: Ryan <fauxpark@gmail.com> * Added info.json for QMK configurator * Update readme.md * This change makes the firmware work... through magic... seriously, no idea - but it works! * Updated dimming step, OLED functionality, and rules for formatting - Changed the dimming step size for smoother dimming with the reduced range - Added lots of OLED functionality - QMK logo and title at top, num/caps/scroll lock status, and backlight brightness level - Updated the rules.mk file to comply more closely with the formatting guidelines * Fixed tab issues Co-authored-by: Ryan <fauxpark@gmail.com> * Updated to use bootmagic lite with the key that usually turns rgb on/off Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/rocketboard_16/readme.md')
-rw-r--r--keyboards/rocketboard_16/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/rocketboard_16/readme.md b/keyboards/rocketboard_16/readme.md
new file mode 100644
index 0000000000..878c2b5caf
--- /dev/null
+++ b/keyboards/rocketboard_16/readme.md
@@ -0,0 +1,13 @@
+# Rocketboard 16
+
+A STM32F103 based macropad/numpad with RGB individual key underglow, dual rotary encoders, and a 128x64 OLED display. [More info on qmk.fm](http://qmk.fm/)
+
+* Keyboard Maintainer: [fl3tching101](https://github.com/fl3tching101)
+* Hardware Supported: Rocketboard 16 PCB rev1.1
+* Hardware Availability: Group buy on r/mechmarket
+
+Make example for this keyboard (after setting up your build environment):
+
+ make rocketboard_16: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).