summaryrefslogtreecommitdiffstats
path: root/keyboards/fjlabs/polaris/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/fjlabs/polaris/readme.md')
-rw-r--r--keyboards/fjlabs/polaris/readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/keyboards/fjlabs/polaris/readme.md b/keyboards/fjlabs/polaris/readme.md
new file mode 100644
index 0000000000..e611430f4d
--- /dev/null
+++ b/keyboards/fjlabs/polaris/readme.md
@@ -0,0 +1,14 @@
+# Polaris-Compatible Hotswap and Solder PCB's
+
+The following is the QMK Firmware for the Polaris-Compatible Hotswap and Solder PCB's developed by FJLaboratories (FJLabs).
+* Keyboard Maintainer: FJLabs
+* Hardware Supported: Polaris Hotswap and Solder
+
+Make example for this keyboard (after setting up your build environment):
+
+ make fjlabs/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).
+
+Bootloader can be entered by pressing the reset button near the main microcontroller while the board is plugged in. Alternatively, it may be entered by holding the top-left-most switch and plugging in the PCB while held. \ No newline at end of file