summaryrefslogtreecommitdiffstats
path: root/keyboards/prototypist/oceanographer/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/prototypist/oceanographer/readme.md')
-rw-r--r--keyboards/prototypist/oceanographer/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/prototypist/oceanographer/readme.md b/keyboards/prototypist/oceanographer/readme.md
new file mode 100644
index 0000000000..63f57c16e9
--- /dev/null
+++ b/keyboards/prototypist/oceanographer/readme.md
@@ -0,0 +1,27 @@
+# prototypist/oceanographer
+
+![prototypist/oceanographer](https://i.imgur.com/loDNEHM.png)
+
+*PCB for the Oceanographer keyboard designed by Hedgey.*
+
+* Keyboard Maintainer: [Josh @ Prototypist](https://github.com/Anjheos)
+* Hardware Supported: **Oceanographer**
+* Hardware Availability: *TBD*
+
+Make example for this keyboard (after setting up your build environment):
+
+ make prototypist/oceanographer:default
+
+Flashing example for this keyboard:
+
+ make prototypist/oceanographer: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 and plug in the keyboard.
+* **Physical reset button**: Briefly press the button on the back of the PCB marked `SWRST1`.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.