From 45a72353b027a335176d22c4484b3f2c00e3551d Mon Sep 17 00:00:00 2001
From: dataprolet <dataprolet@noreply.localhost>
Date: Mon, 19 Aug 2024 15:34:13 +0200
Subject: [PATCH] Add REAMDE.md

---
 REAMDE.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 REAMDE.md

diff --git a/REAMDE.md b/REAMDE.md
new file mode 100644
index 0000000..14ede30
--- /dev/null
+++ b/REAMDE.md
@@ -0,0 +1,28 @@
+## Custom Arch Linux ISO Creator
+  
+This script creates a custom Arch Linux ISO using _archiso_.  
+  
+### Features   
+- installs _archiso_ if not installed  
+- creates working directory _~/.archiso_
+- cleans working directory before
+- writes output into logfile  
+- creates non-root user using your systems global $USER variable  
+- creates a password for the user 
+- adds user to sudoers and wheel group    
+- boots into KDE Plasma using SDDM and auto-logins your user (X11)  
+- contains Firefox and Konsole
+- 
+  
+### Customizablility  
+- add packages to the $pkgs array  
+- change between releng and baseline profile  
+- change username  
+-   
+  
+### Usage  
+Just execute the script:
+
+```
+./archiso.sh
+```
\ No newline at end of file