summaryrefslogtreecommitdiffstats
path: root/keyboards/alpine65/readme.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.volpato@usp.br>2021-01-11 02:41:53 -0300
committerGitHub <noreply@github.com>2021-01-11 00:41:53 -0500
commite688f2286ff382e446804c8676443ed79cde8659 (patch)
treec82ca017e6e24187b6946788e769ee5c0df20cfa /keyboards/alpine65/readme.md
parentffd8ff642d4257fa588d9f42144d923bd570bbbd (diff)
Alpine65 (#11223)
* Initial ALPINE65 support * Fix RGB LED number Co-authored-by: Gondolindrim <alvaro.augusto.volpato@gmail.com>
Diffstat (limited to 'keyboards/alpine65/readme.md')
-rw-r--r--keyboards/alpine65/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/alpine65/readme.md b/keyboards/alpine65/readme.md
new file mode 100644
index 0000000000..0be4396176
--- /dev/null
+++ b/keyboards/alpine65/readme.md
@@ -0,0 +1,15 @@
+# Alpine65 QMK Firmware
+
+## Introduction
+
+This is the QMK firmware repository for the Alpine65, a 65% hotswap keyboard designed by Bitmap Designs and Gondolindrim.
+
+The Alpine65 has entered GB and sucessfully finalized in november 2020; there is no further way to buy an Alpine65 other than the secondhand market. The IC page for the keyboard can be found [here](https://https://geekhack.org/index.php?topic=106974).
+
+## How to compile
+
+After setting up your build environment, you can compile the Alpine65 default keymap by using:
+
+ make alpine65: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).