implemented menu forwarding and made a readme

1 files changed, 46 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d017377
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Basic Kiosk Installer
+A really basic Bash script that helps you display one or multiple websites Kiosk style on Debian based distros.
+
+## Requirements
+What you need
+
+- Option 1 : Debian 12
+    - Base Installation with following :
+        - Locale set to your locale
+        - Hostename set to something appropriate
+        - Password for root set
+        - "kiosk" user made
+        - Software selection : SSH Server and Standard System Utilities (nothing more than that)
+
+- Option 2 : Raspberry Pi OS Lite
+    - Base Image with following :
+        - Network Configured
+        - Locale set to your locale
+        - Hostename set to something appropriate
+        - "kiosk" user made
+        - SSH Enabled
+
+## Debian 12 
+
+### Basic user setup and preparations
+1. sign in to your Debian machine using SSH and kiosk user `ssh kiosk@your.debian.host`
+2. sign into your root account using `su`
+3. install the basics : `apt update && apt upgrade -y && apt install sudo dialog git htop tmux screen screenfetch -y`
+4. add sbin to bash paths for root `echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash`
+5. Add kiosk user to sudo group
+```bash
+bash
+usermod -aG sudo kiosk
+exit
+exit
+exit
+```
+6. Sign back in via ssh `ssh kiosk@your.debian.host`
+7. add sbin to bash paths for kiosk user `echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash`
+8. download the kiosk and go to its folder `git clone https://git.teleco.ch/crt/basic-kiosk.git/ && cd basic-kiosk`
+
+### Installing the Kiosk via Terminal User Interface (TUI/GUI)
+1. run the installer 
+
+
+