summaryrefslogtreecommitdiffstats
path: root/keyboards/acheron/austin/readme.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2020-02-18 00:54:15 +0000
committerGitHub <noreply@github.com>2020-02-18 00:54:15 +0000
commita2081171de25099b0e6be6faa08954ceff2a953b (patch)
treeb0115aab108c4f8f7157a5865aac046be4740f96 /keyboards/acheron/austin/readme.md
parentc66930445f7d5941eb847568288046d51f853786 (diff)
[keyboard] Austin (#8176)
* Add austin keyboard * Update to use spi ws2812 driver * remove rgb
Diffstat (limited to 'keyboards/acheron/austin/readme.md')
-rw-r--r--keyboards/acheron/austin/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/acheron/austin/readme.md b/keyboards/acheron/austin/readme.md
new file mode 100644
index 0000000000..7d7357fd37
--- /dev/null
+++ b/keyboards/acheron/austin/readme.md
@@ -0,0 +1,29 @@
+# Acheron Aχξρων 1800CP-SM-S-STM32-MX-TH-WI (codename "Austin") QMK firmware
+
+<p align="center">
+ <img align="middle" src="https://raw.githubusercontent.com/Gondolindrim/acheronLibrary/master/graphics/acheronLong.png" width="400">
+</p>
+
+## Introduction
+
+This is the QMK firmware repository for the Austin, updated until [revision Alpha](https://github.com/Gondolindrim/Austin/releases/tag/Alpha).
+
+The AustinPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/Austin). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim).
+
+The Austin keyboard is a collaboration between Gondolindrim, DriftingBunnies from DriftMechanics and PheonixStarr from Nightingale Studios.
+
+See the [IC page](https://geekhack.org/index.php?topic=100883) and the [GB page](https://geekhack.org/index.php?topic=102542) for further information. The GB was the only known way to obtain an Austin from the official vendor.
+
+## PCB Documentation
+
+See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/austin/intro.html) page for the AustinPCB full documentation. You can also check the KiCad PCB files at the [Austin GitHub repository](https://github.com/Gondolindrim/Austin).
+
+Before using the files for personal or commercial use, please read the [Acheron Open-Hardware License V1.2](https://gondolindrim.github.io/AcheronDocs/license/license.html) under which the Austin PCB is published.
+
+## How to compile
+
+After setting up your build environment, you can compile the Austin default keymap by using:
+
+ make acheron/austin: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). \ No newline at end of file