From f31e20c7ce4ae27c32aefe58bfd9de4c8a5efe70 Mon Sep 17 00:00:00 2001
From: Joakim Hulthe <joakim@hulthe.net>
Date: Sun, 14 Jul 2024 17:40:19 +0200
Subject: [PATCH] Add a README

---
 README.md        | 34 ++++++++++++++++++++++++++++++++++
 editor/README.md |  3 ---
 2 files changed, 34 insertions(+), 3 deletions(-)
 create mode 100644 README.md
 delete mode 100644 editor/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..faf27f4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+A DIY split keyboard.
+
+## Directory
+
+### `/lib`
+A rust library, and the bulk of the keyboard firmware implementation.
+Written using the Embassy framework.
+
+### `/left` and `/right`
+Rust binaries, one for each half of the split keyboard.
+Most of the actual logic is implemented in `/lib`.
+
+### `/schematic`
+Kicad schematics of the keyboard PCBs.
+
+### `/case`
+3d-printable files of the keyboard case and related plastics.
+
+### `/editor`
+A graphical program for configuring the keyboard layout. Work in progress.
+
+
+## Developing
+
+Required tools:
+- Rust, obviously.
+- `probe-rs` for flashing the firmware. Follow instructions at https://probe.rs/
+- [`flip-link`](https://github.com/knurling-rs/flip-link/)
+- A debug probe of some kind, I recommend a [Pitaya-Link](https://github.com/makerdiary/pitaya-link)
+
+To flash:
+- plug in the probe,
+- `cd` into either `left` or `right`
+- `cargo run`
diff --git a/editor/README.md b/editor/README.md
deleted file mode 100644
index 9de00e7..0000000
--- a/editor/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# tgnt
-
-Keyboard configuration library and editor.