From 3e6b3539cecf4eafbfa598f9e4eed4e269789a6e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 00:31:42 +0200 Subject: [PATCH] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/Hardware-Technomancy-Atreus.md`. This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy --- README.md | 11 ++++------- doc/plugin/Hardware-Technomancy-Atreus.md | 11 +++++++++++ .../Atreus/.kaleidoscope-builder.conf | 0 3 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 doc/plugin/Hardware-Technomancy-Atreus.md rename .kaleidoscope-builder.conf => examples/Atreus/.kaleidoscope-builder.conf (100%) diff --git a/README.md b/README.md index fb7fcfc1..0b635026 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ # Kaleidoscope-Hardware-Technomancy-Atreus -This is a plugin for [Kaleidoscope][fw], that adds hardware support for the -[Atreus][atreus]. Supported models include post-2016 PCB variants with an A* -MCU, and the hand-wired variant from [FalbaTech][falba] with a Teensy2. +[![Build Status][travis:image]][travis:status] -PCBs prior to 2016, and the legacy teensy2 variants are not supported. + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-Hardware-Technomancy-Atreus - [fw]: https://github.com/keyboardio/Kaleidoscope - [atreus]: https://atreus.technomancy.us/ - [falba]: https://falba.tech/ +See [doc/plugin/Hardware-Technomancy-Atreus.md](doc/plugin/Hardware-Technomancy-Atreus.md) for documentation. diff --git a/doc/plugin/Hardware-Technomancy-Atreus.md b/doc/plugin/Hardware-Technomancy-Atreus.md new file mode 100644 index 00000000..fb7fcfc1 --- /dev/null +++ b/doc/plugin/Hardware-Technomancy-Atreus.md @@ -0,0 +1,11 @@ +# Kaleidoscope-Hardware-Technomancy-Atreus + +This is a plugin for [Kaleidoscope][fw], that adds hardware support for the +[Atreus][atreus]. Supported models include post-2016 PCB variants with an A* +MCU, and the hand-wired variant from [FalbaTech][falba] with a Teensy2. + +PCBs prior to 2016, and the legacy teensy2 variants are not supported. + + [fw]: https://github.com/keyboardio/Kaleidoscope + [atreus]: https://atreus.technomancy.us/ + [falba]: https://falba.tech/ diff --git a/.kaleidoscope-builder.conf b/examples/Atreus/.kaleidoscope-builder.conf similarity index 100% rename from .kaleidoscope-builder.conf rename to examples/Atreus/.kaleidoscope-builder.conf