aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/subatomic/readme.md
diff options
context:
space:
mode:
authornoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-09-25 13:17:29 -0700
committerDrashna Jaelre <drashna@live.com>2019-09-25 13:17:29 -0700
commitdccafb64e65bfe2516eba422609750e9c27775e7 (patch)
treee089d34b4983ff19e2adf441a491eb74186c1512 /keyboards/subatomic/readme.md
parent475f832b0f434615b9b32ca3f600c4b770d6e1e5 (diff)
downloadfirmware-dccafb64e65bfe2516eba422609750e9c27775e7.tar.gz
firmware-dccafb64e65bfe2516eba422609750e9c27775e7.tar.bz2
firmware-dccafb64e65bfe2516eba422609750e9c27775e7.zip
[Keyboard] Subatomic refactor (#3194)
* Refactor: matrix * New readme file * Configurator support * change info.json to debug linting * use an enum to manage the layers * readme cleanup file header, docs links * use #pragma once in keyboard header file * use new-style OLKB layout macro naming scheme * fix layout macro references in keymap.c * correct Keyboard Maintainer
Diffstat (limited to 'keyboards/subatomic/readme.md')
-rw-r--r--keyboards/subatomic/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/subatomic/readme.md b/keyboards/subatomic/readme.md
new file mode 100644
index 000000000..ca065b29a
--- /dev/null
+++ b/keyboards/subatomic/readme.md
@@ -0,0 +1,15 @@
+# Subatomic
+
+![Subatomic](https://i.imgur.com/EWrY7Bel.png)
+
+A compact 70% (15x4) ortholinear keyboard kit made and sold by OLKB. [More info on qmk.fm](http://qmk.fm/subatomic/)
+
+Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
+Hardware Supported: Subatomic PCB
+Hardware Availability: TBD
+
+Make example for this keyboard (after setting up your build environment):
+
+ make subatomic:default
+
+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).