diff options
Diffstat (limited to 'keyboards/acheron/elongate/readme.md')
| -rw-r--r-- | keyboards/acheron/elongate/readme.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/acheron/elongate/readme.md b/keyboards/acheron/elongate/readme.md new file mode 100644 index 0000000000..83c0eeada1 --- /dev/null +++ b/keyboards/acheron/elongate/readme.md @@ -0,0 +1,25 @@ +# Acheron Aχξρων 45-S-ATMEGA-MX-TH-WI (codename "Elongate") 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 ElongatePCN, compatible with revisions Beta and pre-Beta. + +The ElongatePCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/AElongate). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim). + +## PCB Documentation + +See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/elongate/introduction.html) page for the ElongatePCB full documentation. You can also check the KiCad PCB files at the [Elongate GitHub repository](https://github.com/Gondolindrim/Elongate). + +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/elongate: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). |