diff options
Diffstat (limited to 'keyboards/acheron/keebspcb/readme.md')
| -rw-r--r-- | keyboards/acheron/keebspcb/readme.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/keyboards/acheron/keebspcb/readme.md b/keyboards/acheron/keebspcb/readme.md new file mode 100644 index 000000000..22de968c7 --- /dev/null +++ b/keyboards/acheron/keebspcb/readme.md | |||
| @@ -0,0 +1,33 @@ | |||
| 1 | # Acheron Aχξρων 60-SM-S-STM32-MX-HS-WI (codename "KeebsPCB") QMK firmware | ||
| 2 | |||
| 3 | <p align="center"> | ||
| 4 | <img align="middle" src="https://raw.githubusercontent.com/Gondolindrim/acheronLibrary/master/graphics/acheronLong.png" width="400"> | ||
| 5 | </p> | ||
| 6 | |||
| 7 | ## Introduction | ||
| 8 | |||
| 9 | This is the QMK firmware repository for the KeebsPCB, updated until [pre-revision Alpha](https://github.com/Gondolindrim/KeebsPCB/releases/tag/pre-Alpha). | ||
| 10 | |||
| 11 | 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). | ||
| 12 | |||
| 13 | 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. | ||
| 14 | |||
| 15 | 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. | ||
| 16 | |||
| 17 | ## Layouts | ||
| 18 | |||
| 19 | The PCB offers a single layout consisting of a default ANSI layout with 7U bottom row. | ||
| 20 | |||
| 21 | ## PCB Documentation | ||
| 22 | |||
| 23 | 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). | ||
| 24 | |||
| 25 | 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. | ||
| 26 | |||
| 27 | ## How to compile | ||
| 28 | |||
| 29 | After setting up your build environment, you can compile the KeebsPCB default keymap by using: | ||
| 30 | |||
| 31 | make acheron/keebspcb:default | ||
| 32 | |||
| 33 | 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). | ||
