diff --git a/README.md b/README.md index 781da38..6d0b181 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ Resources and designs for the custom keyboards I have created. +## The Keyboards + +### Chrysemys + +[Source Files](https://git.sr.ht/~tgrosinger/keyboards/tree/main/item/chrysemys) + +A 34-key single-board keyboard created with [Ergogen](https://ergogen.xyz). Powered by a ProMicro-compatible board, such as the nice!nano. + +This keyboard is my first attempt at using Ergogen, and my first custom keyboard, so it will likely be rough around the edges. I predict there will be future keyboards listed here which refine the ideas implemented in this board. + +### Future Keyboards + +I'd like to eventually work towards putting the MCU directly on the keyboard PCB. It however does not seem wise to do this until I have a functional keyboard under my belt. + ## License All files in this repository are covered by the GPLv3 license. See the [LICENSE](https://git.sr.ht/~tgrosinger/keyboards/tree/main/item/LICENSE) file for more information. diff --git a/chrysemys/README.md b/chrysemys/README.md index 6120063..9843cf3 100644 --- a/chrysemys/README.md +++ b/chrysemys/README.md @@ -1,6 +1,17 @@ # Chrysemys -A 34-key keyboard created with [Ergogen](https://ergogen.xyz). +A 34-key single-board keyboard created with [Ergogen](https://ergogen.xyz). + +## Design Goals + +- Bluetooth connectivity. +- Single board, with an outward rotation between the two halves for ergonomic comfort. +- Using the ZMK firmware, as it has the best bluetooth support at the moment. +- A focus on keeping the entire keyboard as thin as possible. + +## Bill of Materials + +Work in progress ## Inspiration