From df68160728ccccacd7f40946187cf6bd960face0 Mon Sep 17 00:00:00 2001
From: stornic56 <71296607+stornic56@users.noreply.github.com>
Date: Tue, 5 May 2026 20:53:34 -0500
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d04d22
--- /dev/null
+++ b/README.md
@@ -0,0 +1,85 @@
+# Debianito - Post-Installation Automation for Debian
+
+<div align="center">
+
+Debianito is a user-friendly post-installation automation script for Debian 12 (Bookworm) and Debian 13 (Trixie). It streamlines system configuration, driver installation, repository setup, gaming tools integration, and more with an interactive menu-driven interface.
+
+[![License: AGPL v3](https://img.shields.io/badge/License--AGPLv3-green.svg "GNU Affero GPL 3.0")](https://github.com/stornic56/debianito-post-install/blob/main/LICENSE)
+
+</div>
+
+---
+
+## System Requirements
+
+| Requirement | Specification |
+|-------------|---------------|
+| **OS**      | Debian 12 (Bookworm), Debian 13 (Trixie) |
+| **Privileges** | Script must be run with `sudo` privileges by a normal user |
+| **Terminal**   | Any modern terminal emulator that supports ANSI colors and UTF-8 box-drawing characters |
+| **Dependencies**     | Standard Debian packages; script will install missing dependencies (e.g., `whiptail`, `lsb-release`) where necessary. |
+
+---
+
+## Installation Instructions
+
+### Step 1: Clone or Download the Repository
+
+```bash
+git clone https://github.com/stornic56/debianito-post-install
+cd debianito
+chmod +x post-install.sh modules/*.sh # Make all scripts executable if needed
+```
+
+If you downloaded manually, ensure all `.sh` files are in their respective directories.
+
+### Step 2: Run the Script with Sudo Privileges
+
+>  **Do not run this script as root.** Use a normal user account and authorize via `sudo`.
+
+```bash
+./post-install.sh
+```
+
+The script will perform initial checks, detect your system information (CPU, RAM, GPU), then present an interactive menu.
+
+---
+
+## Usage 
+
+After running the script:
+
+1. **Select Option:** Use arrow keys or type `1-7`.
+2. **Confirm Actions:** For installation steps, you'll see a confirmation prompt (`whiptail`).
+3. **Review System Info:** The header displays your detected Debian version and hardware summary before each action.
+4. **Repeat as Needed:** Return to the main menu at any time or exit when done.
+
+|Menu Option|What it does|
+|-------------|------------------------------------------------------------------------------|
+|User Privileges & Feedback|Add user to sudo group + password feedback|
+|Repository Configuration|Setup official repos with/without backports|
+|Wireless Support|Install WiFi firmware for Broadcom, Intel, etc.|
+|Graphics Stack and Tools|AMD/Intel/NVIDIA drivers + monitoring tools (nvtop/radeontop)|
+|Gaming Setup|Steam installation + performance tools (gamemode/mangohud)|
+|Extra Applications|Select system utilities like htop, btop, neofetch|
+
+---
+
+## File Structure
+
+| Directory/File | Description |
+|----------------|-------------|
+| `/post-install.sh` | Main entry point; handles menu navigation and system detection. |
+| `/modules/` | Modular scripts for specific tasks: `sudo_config`, `repos`, `firmware`, `gpu`, etc. |
+| `utils.sh` | Shared utility functions (CPU/RAM/GPU/WiFi detection, Debian version identification). |
+
+```bash
+├── post-install.sh          # Main script & menu logic
+└── modules/
+    ├── utils.sh             # System info helpers
+    ├── sudo_config.sh       # User group + pwfeedback setup
+    ├── repos.sh             # Repository configuration (classic/deb822)
+    ├── firmware.sh          # WiFi microcode and chipset-specific support
+    ├── gpu.sh               # AMD, Intel, NVIDIA driver/firmware handling
+    └── gaming.sh            # Steam installation & performance tools
+```