summaryrefslogtreecommitdiffstats
path: root/keyboards/laptreus/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/laptreus/readme.md')
-rw-r--r--keyboards/laptreus/readme.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/keyboards/laptreus/readme.md b/keyboards/laptreus/readme.md
new file mode 100644
index 000000000..e27c20604
--- /dev/null
+++ b/keyboards/laptreus/readme.md
@@ -0,0 +1,35 @@
+# Laptreus
+
+TODO: Insert cool photo
+
+Laptreus is a 40% bluetooth keyboard in the style of the Atreus, which is specifically designed to sit atop your laptop keyboard.
+
+Maintainer: [Chuck Lauer Vose](https://github.com/vosechu)
+MCU: Adafruit Feather 32u4 BLE
+Purchase link: GB coming soon
+Case link: GB coming soon
+Case design files: TODO
+
+## Flashing
+
+**NOTE**: Make sure you don't have a second QMK keyboard plugged in when you do this!
+
+[Default layout documentation](https://github.com/qmk/qmk_firmware/tree/master/keyboards/laptreus/keymaps/default)
+
+To compile and flash to the board:
+
+ make laptreus:default:avrdude
+
+To just compile:
+
+ make laptreus:default
+
+Then use QMK toolbox to write the file
+
+## Changelog
+
+v1.2: Mostly working, but JST connector is a little too tight and the reset switch is not connected.
+
+## Build log
+
+TODO