summaryrefslogtreecommitdiff
path: root/keyboards/nightly_boards/octopad/readme.md
diff options
context:
space:
mode:
authorNightlyBoards <65656486+NightlyBoards@users.noreply.github.com>2020-12-30 08:58:14 +0800
committerGitHub <noreply@github.com>2020-12-29 16:58:14 -0800
commitac433b218d2f0652833155f5eaa6b0c287f9cdec (patch)
treea23a9a953daf25a560026b80f0a857dd809aa9f4 /keyboards/nightly_boards/octopad/readme.md
parent8ee03f6a6b3216fa0d4372d4db8c09f24473c6c6 (diff)
[Keyboard] Add the Octopad (#9946)
* Create Alter folder * Revert "Create Alter folder" This reverts commit 361103b821dbb22957b66cdedb0d11f996def71c. * Add octopad folder * Added a new keyboard, the Octopad * Edited files based on requested changes * Moved encoder code in keyboard level * Updated the readme * Corrected the rows and columns of encoders on config.h * Changed the Vendor ID to D812 since the first one was already taken * Added support for ast1109MLTRQ speakers * Increased number of layers to 8 on VIA keymap * Edited files based on comments * Edited rules.mk as per comment * Edited readme.md as per comment
Diffstat (limited to 'keyboards/nightly_boards/octopad/readme.md')
-rw-r--r--keyboards/nightly_boards/octopad/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/nightly_boards/octopad/readme.md b/keyboards/nightly_boards/octopad/readme.md
new file mode 100644
index 0000000000..022bd3182e
--- /dev/null
+++ b/keyboards/nightly_boards/octopad/readme.md
@@ -0,0 +1,20 @@
+# Nightly Boards Octopad
+
+![octopad](https://i.imgur.com/MkSzzGBl.jpg)
+
+An 8 key macropad with 2 rotary encoders
+
+* Keyboard Maintainer: [Neil Brian Ramirez](https://github.com/NightlyBoards)
+* Hardware Supported: atmega32u4
+
+Make example for this keyboard (after setting up your build environment):
+
+ make nightly_boards/octopad:default
+
+Flashing example for this keyboard:
+
+ make nightly_boards/octopad:default:flash
+
+You can enter bootloader mode by pressing the physical reset button at the back of the pcb or by holding the upper left key (among the 8 keys) while plugging the usb cable.
+
+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).