README.md

@@ -1,10 +1,74 @@
-# OptimaLab35-installer
+# OptimaLab35 Installer
 
-Installation script (linux) to install OptimaLab35 (and micromamba) and setup desktop shortcut.
+This is a Linux installation script for **[OptimaLab35](https://code.boxyfoxy.net/CodeByMrFinchum/OptimaLab35)**.
+It will:
 
-run by
-```Bash
-"${SHELL}" <(curl -L https://code.boxyfoxy.net/CodeByMrFinchum/OptimaLab35-installer/raw/branch/feat/init/OL35-installer.sh)
+- Install **Micromamba** with default settings (if it’s not already installed in the default path).
+- Create a Micromamba environment containing **OptimaLab35** (installed via `pip`).
+- Create a desktop shortcut for launching OptimaLab35.
+
+If you do **not** want to use Micromamba or have it installed in a different location, see **line 41** of the installer script (where `$DESKTOP_DIR/OptimaLab35.desktop` is created) and adjust accordingly.
+This script is **not** meant to be a universal installer for all Python environments — it’s tailored for my setup using Micromamba for quick deployment with a desktop shortcut.
+
+---
+
+## Usage
+
+Run this in a terminal:
+
+```bash
+"${SHELL}" <(curl -L https://code.boxyfoxy.net/CodeByMrFinchum/OptimaLab35-installer/raw/branch/main/OL35-installer.sh)
 ```
-# Disclaimer
-GAI(LLM) ChatGPT was used to generate parts of this project.
+
+**Tip:** You can paste the URL into your browser to review the script before running it - you should never blindly execute random scripts from the internet.
+
+---
+
+## How to Update OptimaLab35
+
+OptimaLab35 includes a built-in updater:
+
+1. Open the **Settings** menu.
+2. Click **Check for update**.
+3. If an update is available, click **Update** and restart the application.
+
+---
+
+## How it Works
+
+1. **Micromamba Check**
+
+   - If `micromamba` is not found in its default location (`~/micromamba`), it is installed automatically using:
+
+     ```bash
+     "${SHELL}" <(curl -L micro.mamba.pm/install.sh)
+     ```
+  - During installation, **use the default settings** — just press Enter for each prompt (binary folder, init shell, configure conda-forge, and prefix location).
+
+2. **Environment Creation**
+
+   - A Micromamba environment named `ol` is created (or updated) and OptimaLab35 is installed into it via `pip`.
+
+3. **Configuration Setup**
+
+   - A configuration directory is created at:
+
+     ```
+     ~/.config/OptimaLab35
+     ```
+   - A logo image is downloaded from the repository for use in the desktop shortcut.
+
+4. **Desktop Shortcut Creation**
+
+   - A `.desktop` file is placed in:
+
+     ```
+     ~/.local/share/applications/
+     ```
+   - This allows you to launch OptimaLab35 from your system’s application menu.
+
+---
+
+## GAI Disclaimer
+
+ChatGPT was used for discussion and code generation in this project - including both Bash snippets and English language improvements.