aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ai03/polaris/readme.md
diff options
context:
space:
mode:
authorai03 <sarcaphx510@gmail.com>2020-02-10 00:53:16 -0800
committerGitHub <noreply@github.com>2020-02-10 00:53:16 -0800
commit8f333138f5cc76ecc7538100ce93af5e228f0eb0 (patch)
treeb23d0cd562b48f5b956e6cd7f7b7b2f6cfd43b60 /keyboards/ai03/polaris/readme.md
parent35c4dbe688f2db07426990c5980e9c70b4ff5667 (diff)
downloadfirmware-8f333138f5cc76ecc7538100ce93af5e228f0eb0.tar.gz
firmware-8f333138f5cc76ecc7538100ce93af5e228f0eb0.tar.bz2
firmware-8f333138f5cc76ecc7538100ce93af5e228f0eb0.zip
[Keyboard] Add support for Polaris (#8123)
* Drop in old files * Make a blank template keyboard to refresh ancient files to latest config * Update keymaps files to new format * Remove chunks of config asked for removal in previous pullreqs * Remove split pin option from config * Update rules.mk to latest version * Remove unused functions from polaris.c * Add via keymap * Build basic tsangan keymap; add QMK configurator info * Remove temporary template * Update keyboards/ai03/polaris/config.h * Update keyboards/ai03/polaris/readme.md * Update keyboards/ai03/polaris/readme.md * Update keyboards/ai03/polaris/readme.md * Update rules.mk * Fixes as per pullreq * Update keyboards/ai03/polaris/keymaps/default_ansi_tsangan/keymap.c * Update keyboards/ai03/polaris/polaris.h * Update keyboards/ai03/polaris/keymaps/default_ansi_tsangan/keymap.c * Update keyboards/ai03/polaris/info.json * Update keyboards/ai03/polaris/keymaps/testing/readme.md
Diffstat (limited to 'keyboards/ai03/polaris/readme.md')
-rw-r--r--keyboards/ai03/polaris/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/ai03/polaris/readme.md b/keyboards/ai03/polaris/readme.md
new file mode 100644
index 000000000..c9c8e7e22
--- /dev/null
+++ b/keyboards/ai03/polaris/readme.md
@@ -0,0 +1,15 @@
+# Polaris
+
+![Polaris](https://i.imgur.com/bENjPiKh.jpg)
+
+A basic 60% keyboard
+
+* Keyboard Maintainer: [ai03](https://github.com/ai03-2725)
+* Hardware Supported: Polaris PCB/case
+* Hardware Availability: Will be posted [here](https://kb.ai03.me/projects/polaris.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ai03/polaris: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).