From 3ca571787f749e4fe03eaf24ef4e4df462aa3f67 Mon Sep 17 00:00:00 2001 From: KemoNine Date: Fri, 26 Feb 2021 23:53:24 +0000 Subject: [PATCH] Cleanup main readme, add readme to shields directory --- README.md | 2 +- config/boards/shields/README.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 config/boards/shields/README.md diff --git a/README.md b/README.md index 1cd5b72..553ea25 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ZMK ARTSEY Implementation -This repo contains the ZMK ARTSEY implementation and pre-built firmware for boards that have been setup to use ARTSEY by the core ARTSEY development team. +This repo contains the [ZMK](https://zmkfirmware.dev/) ARTSEY implementation and pre-built firmware for boards that have been setup to use ARTSEY by the core ARTSEY development team. ## Prebuilt Firmware diff --git a/config/boards/shields/README.md b/config/boards/shields/README.md new file mode 100644 index 0000000..600eb1f --- /dev/null +++ b/config/boards/shields/README.md @@ -0,0 +1,3 @@ +# shields + +This directory contains the specific ZMK ARTSEY impementations for various keyboards. Please see the sub directories for specific implementation details.