summaryrefslogtreecommitdiffstats
path: root/keyboards/ai03/orbit_x/readme.md
diff options
context:
space:
mode:
authorai03 <sarcaphx510@gmail.com>2020-04-03 20:33:53 +0900
committerGitHub <noreply@github.com>2020-04-03 04:33:53 -0700
commit2f623daa459eeab29f2bdfe03bc7c2c05e875d45 (patch)
tree15663d88fb28b0966e44c6327d4e515511a4408a /keyboards/ai03/orbit_x/readme.md
parentebbaba9001c09f904e29b16f9b0458afdefdae2f (diff)
[Keyboard] Add Orbit-X Keyboard (#8605)
* Make initial batch of files * Tweak keymap * Mod default keymap * Add via compat * Update default keymap based on real world use * Remove RGB, LCD, MIDI options * Remove unnecessary functons from orbit_x.c * Update readme * Cleanup makefile as necessary * Make the readme file for default keymap not completely empty * Update keyboards/ai03/orbit_x/keymaps/default/keymap.c * Update keyboards/ai03/orbit_x/readme.md * Update keyboards/ai03/orbit_x/info.json
Diffstat (limited to 'keyboards/ai03/orbit_x/readme.md')
-rw-r--r--keyboards/ai03/orbit_x/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/ai03/orbit_x/readme.md b/keyboards/ai03/orbit_x/readme.md
new file mode 100644
index 0000000000..80bc6bbab8
--- /dev/null
+++ b/keyboards/ai03/orbit_x/readme.md
@@ -0,0 +1,15 @@
+# Orbit-X
+
+![orbit_x](https://i.imgur.com/4z2wgsV.png)
+
+A compact high-end split keyboard
+
+* Keyboard Maintainer: [ai03](https://github.com/ai03-2725)
+* Hardware Supported: The Orbit-X keyboard PCB
+* Hardware Availability: Deskeys for official kit; open-source PCB [here](https://github.com/ai03-2725/Orbit/tree/master/OrbitX-PCB)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ai03/orbit_x:via
+
+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).