aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/acheron/elongate/readme.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.volpato@usp.br>2020-05-06 13:11:59 -0300
committerGitHub <noreply@github.com>2020-05-06 17:11:59 +0100
commitb18c261040f6473fa445e57c80f1c5646797105c (patch)
tree5e025483b76077c6b9bbfda85d5606db284e64d4 /keyboards/acheron/elongate/readme.md
parentbac5d6bc6ade705f1d10f42385e420686bb182d5 (diff)
downloadfirmware-b18c261040f6473fa445e57c80f1c5646797105c.tar.gz
firmware-b18c261040f6473fa445e57c80f1c5646797105c.tar.bz2
firmware-b18c261040f6473fa445e57c80f1c5646797105c.zip
Add Elongate PCB support (#8419)
* Working on proto * Start adding VIA support * Apply suggestions from code review Removed redundant comments and fixed typos Co-Authored-By: Ryan <fauxpark@gmail.com> Co-Authored-By: Joel Challis <git@zvecr.com> * Delete useless config.h As per code review * Delete elongate.c As per code review * Updated readme.md * Update keyboards/acheron/elongate/keymaps/default/keymap.c As per code review Co-Authored-By: Ryan <fauxpark@gmail.com> * Apply suggestions from code review Removed RGB_MODE_TEST definition and substituted for RGB_M_T Co-Authored-By: Ryan <fauxpark@gmail.com> * Apply suggestions from code review Reverted changes to alice.h Co-Authored-By: Ryan <fauxpark@gmail.com> * Update info.json * Update via/keymap.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Solve compiling issue for via keymap * Add botmagic support and remoce console_enable Co-Authored-By: Joel Challis <git@zvecr.com> * Update keyboards/acheron/elongate/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/acheron/elongate/keymaps/via/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/acheron/elongate/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/acheron/elongate/config.h Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Gondolindrim <alvaro.augusto.volpato@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'keyboards/acheron/elongate/readme.md')
-rw-r--r--keyboards/acheron/elongate/readme.md25
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 000000000..83c0eeada
--- /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).