From c77a3da57cb06205824a408aa7b0d26d2d37e765 Mon Sep 17 00:00:00 2001
From: Deon Spengler <deon@spengler.co.za>
Date: Thu, 15 Jun 2023 21:23:16 +0200
Subject: [PATCH] Inital readme

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..efd6123
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+CyberDeck - K42
+===============
+
+This cyberdeck is mostly 3D printed and includes the following stand out features
+* Room temperature and humidity sensor
+* Air quality sensor
+* GPS used to create a stratum level 1 time server
+* Integrated split keyboard powered by a Raspberry Pi Pico
+* Ultrawide main display
+* Addtional oled display for sensor information and notifications
+
+
+Software
+========
+
+Ach linux is used as the base operating systems.
+* Wayland (performance is much better on wayland than Xorg when it comes to the Raspberry Pi 4 hardware)
+* Pipewire (this is a good middle ground between PulseAudio and Jack2)
+* Sway (tiling windows manager for wayland)
+* foot (terminal emulator with sixel support and includes a server / client architechure)
+* ranger (terminal based file manager)
+* gomuks (matrix terminal client)
+