summaryrefslogtreecommitdiffstats
path: root/keyboards/ai03/orbit/readme.md
diff options
context:
space:
mode:
authorai03 <sarcaphx510@gmail.com>2019-03-11 03:57:36 +0100
committerDrashna Jaelre <drashna@live.com>2019-03-11 03:57:36 +0100
commit9bea41c9b239916ae8786e7df02c29fad79ef459 (patch)
treeb9b4b3cdacd87156ebc29e70a79e846cb32e8679 /keyboards/ai03/orbit/readme.md
parentad12acd3c049e1eef02ac21bb749eda375e09cec (diff)
downloadqmk_firmware-9bea41c9b239916ae8786e7df02c29fad79ef459.tar.gz
qmk_firmware-9bea41c9b239916ae8786e7df02c29fad79ef459.tar.xz
[Keyboard] Add Orbit keyboard (#5306)
* Get things working except indicators * Attempt to get things working * hmm * Compiles but doesn't run * Make data transfer work * Get all indicators working * Remove old transport * Prepare for pullreq * Revert keymap from testing to production * Final error checking for pull request * Remove autogenerated is_command from config.h * Rewrite pin toggles using qmk functions
Diffstat (limited to 'keyboards/ai03/orbit/readme.md')
-rw-r--r--keyboards/ai03/orbit/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/ai03/orbit/readme.md b/keyboards/ai03/orbit/readme.md
new file mode 100644
index 000000000..58ba2079d
--- /dev/null
+++ b/keyboards/ai03/orbit/readme.md
@@ -0,0 +1,15 @@
+# Orbit
+
+![Orbit](https://raw.githubusercontent.com/ai03-2725/Orbit/master/Images/PCB-R2.0.jpg)
+
+A split ergonomic keyboard project.
+
+Keyboard Maintainer: [ai03](https://github.com/ai03-2725)
+Hardware Supported: The [Orbit PCB](https://github.com/ai03-2725/Orbit)
+Hardware Availability: [This repository](https://github.com/ai03-2725/Orbit) has PCB files. Case group buy orders are currently closed.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ai03/orbit: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).