summaryrefslogtreecommitdiff
path: root/keyboards/ergoslab/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ergoslab/readme.md')
-rw-r--r--keyboards/ergoslab/readme.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/keyboards/ergoslab/readme.md b/keyboards/ergoslab/readme.md
new file mode 100644
index 0000000000..9343f3bc9e
--- /dev/null
+++ b/keyboards/ergoslab/readme.md
@@ -0,0 +1,33 @@
+# ergoslab
+
+![ergoslab](https://raw.githubusercontent.com/tomsaleeba/ergoslab/master/ergoslab.jpg)
+
+
+A split ergo 5x6 keyboard with hotswap sockets and a heap of thumb keys designed
+by Tom Saleeba. [More info on the GitHub
+Repo](https://github.com/tomsaleeba/ergoslab).
+
+**Status** The ergoslab is currently being beta-tested.
+
+* Keyboard Maintainer: [Tom Saleeba](https://github.com/tomsaleeba)
+* Hardware Supported: Pro Micro (ATmega32U4)
+* Hardware Availability: gerbers are available from the [releases page on the
+GitHub repo](https://github.com/tomsaleeba/ergoslab/releases). Get them
+manufactured at your favourite PCB house. I used JLCPCB.
+
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ergoslab:default
+
+Example of flashing this keyboard:
+
+ make ergoslab: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).
+
+A build guide for this keyboard can be found here: [Build
+Guide](https://github.com/tomsaleeba/ergoslab/blob/master/build-guide.md)