summaryrefslogtreecommitdiff
path: root/keyboards/handwired/baredev/rev1/readme.md
diff options
context:
space:
mode:
authorFernando Rodrigues <fernando.delphi@gmail.com>2021-12-27 07:19:34 -0300
committerGitHub <noreply@github.com>2021-12-27 21:19:34 +1100
commit58600146a9d7290c6cc36e026d0d535826c495a6 (patch)
treed32281c216e0d937ab53cce17520fb9776e67833 /keyboards/handwired/baredev/rev1/readme.md
parent235c666f3d79ca42f8bc529bf006473396cb0bba (diff)
Added BareDev keyboard (#15518)
* Added BareDev keyboard * Updated readme.md to reflect handwired directory * Simplified keycodes for basic GUI + [KEY]
Diffstat (limited to 'keyboards/handwired/baredev/rev1/readme.md')
-rw-r--r--keyboards/handwired/baredev/rev1/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/handwired/baredev/rev1/readme.md b/keyboards/handwired/baredev/rev1/readme.md
new file mode 100644
index 0000000000..3f852f2bc6
--- /dev/null
+++ b/keyboards/handwired/baredev/rev1/readme.md
@@ -0,0 +1,29 @@
+# BareDev (rev1)
+
+![PCB](https://i.imgur.com/byquO5u.png)
+![Prototype Build](https://i.imgur.com/fkizunN.png)
+
+An open-source, ABNT2-based 70% keyboard, focusing in a smaller footprint while retaining all the functions found on a TKL (Del and arrow keys doubling as the navigational cluster)
+
+* Keyboard Maintainer: [Fernando "ManoShu" Rodrigues](https://github.com/ManoShu)
+* Hardware Supported: BareDev rev1 PCB
+* Hardware Availability: Files available on [GitHub](https://github.com/ManoShu/BareDev)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/baredev/rev1:default
+
+Flashing example for this keyboard:
+
+ make handwired/baredev/rev1:default:flash
+
+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).
+
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available \ No newline at end of file