summaryrefslogtreecommitdiffstats
path: root/keyboards/laptreus/readme.md
diff options
context:
space:
mode:
authorChuck Lauer Vose <vosechu@gmail.com>2019-02-06 23:41:17 +0100
committerDrashna Jaelre <drashna@live.com>2019-02-06 23:41:17 +0100
commita3104a71105e7743c778c47617dce0468bf8dc1f (patch)
treee98ae28920f033b26dfddbd6b5d9e5366c40c2b7 /keyboards/laptreus/readme.md
parent35f6919673c57a9fea9305a001c0069e8bbc2844 (diff)
downloadqmk_firmware-a3104a71105e7743c778c47617dce0468bf8dc1f.tar.gz
qmk_firmware-a3104a71105e7743c778c47617dce0468bf8dc1f.tar.xz
[Keyboard] Initial commit of Laptreus Keyboard (#4967)
* Add userspace files for vosechu * Code review corrections * Few more code review corrections * Initial add of Laptreus code * Initial add of Laptreus code * Adding last punctuation to default * Add some debug suggestions to the debug readme * Fixes for PR feedback * Fixing capitalization of readme files * update auto detect connection logic
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