From d68c4d810634f5ffcb29c38d57b16bc72faf45dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20A=2E=20Volpato?= Date: Wed, 25 Mar 2020 23:22:08 -0300 Subject: Add KeebsPCB pre-Alpha support (#8485) * Add initial KeebsPCB support * Update readme * Update readme * Correct readme typo * Update keyboards/acheron/keebspcb/config.h Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Apply @noroadsleft suggestions from code review Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/acheron/keebspcb/info.json Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/acheron/keebspcb/keymaps/default/keymap.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Gondolindrim Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> --- keyboards/acheron/keebspcb/readme.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 keyboards/acheron/keebspcb/readme.md (limited to 'keyboards/acheron/keebspcb/readme.md') diff --git a/keyboards/acheron/keebspcb/readme.md b/keyboards/acheron/keebspcb/readme.md new file mode 100644 index 0000000000..22de968c7d --- /dev/null +++ b/keyboards/acheron/keebspcb/readme.md @@ -0,0 +1,33 @@ +# Acheron Aχξρων 60-SM-S-STM32-MX-HS-WI (codename "KeebsPCB") QMK firmware + +

+ +

+ +## Introduction + +This is the QMK firmware repository for the KeebsPCB, updated until [pre-revision Alpha](https://github.com/Gondolindrim/KeebsPCB/releases/tag/pre-Alpha). + +The KeebsPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/KeebsPCB). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim). + +The KeebsPCB is a collaboration between Gondolindrim and MrKeebs; its layouts and features were cherry-picked by MrKeebs and the PCB was designed for him with these chosen features. + +As of may 2020, there is no way to buy an KeebsPCB through a vendor or Group Buy; the only possible way is ordering them directly from a manufacturer. + +## Layouts + +The PCB offers a single layout consisting of a default ANSI layout with 7U bottom row. + +## PCB Documentation + +See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/keebs/intro.html) page for the KeebsPCB full documentation. You can also check the KiCad PCB files at the [KeebsPCB GitHub repository](https://github.com/Gondolindrim/KeebsPCB). + +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 KeebsPCB default keymap by using: + + make acheron/keebspcb: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). -- cgit v1.2.3