Skip to content

Commit 849c043

Browse files
authored
docs: Update README for v0.2.1 release (credentials, software list)
1 parent 2ff689e commit 849c043

File tree

1 file changed

+49
-18
lines changed

1 file changed

+49
-18
lines changed

README.md

Lines changed: 49 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,56 @@
11
# LuminOS Build Scripts
22

3-
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)]()
3+
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)]() [![Version](https://img.shields.io/badge/version-v0.2.1-blue)]()
44

5-
Welcome to the official build repository for **LuminOS**.
5+
Welcome to the official repository for **LuminOS**.
66

7-
**LuminOS** is a lightweight, private, and intelligent Linux distribution based on Debian 13 "Trixie". It features native integration of **Lumin**, a local, offline, and ethical AI assistant.
7+
**LuminOS** is a lightweight, private, and intelligent Linux distribution based on **Debian 13 (Trixie)**. It features native integration of **Lumin**, a 100% local, offline AI assistant, and a curated suite of productivity tool
88

99
---
1010

11-
## 🏗️ Build Architecture (v0.2)
11+
## 💿 Getting Started (Live ISO)
1212

13-
We choose a **transparent, manual build process** to ensure stability.
13+
### Default Credentials
14+
If you boot the ISO, use these credentials to log in:
15+
* **User:** `liveuser`
16+
* **Password:** `luminos`
1417

15-
The master script `build.sh` orchestrates the entire pipeline:
16-
1. **Bootstrap:** Creates a base Debian system using `debootstrap`.
17-
2. **AI Prep:** Pre-downloads Ollama and models on the host to avoid network issues
18-
3. **Injection:** Copies scripts and assets into the system.
19-
4. **Customization:** Executes scripts `02` through `07` inside the system (chroot) to install KDE, themes, and configure settings.
20-
5. **Assembly:** Compresses the filesystem and generates the ISO.
18+
> **⚠️ Important for AZERTY Users:**
19+
> The live system boots with a **US (QWERTY)** keyboard layout by default.
20+
> To type `luminos`, you must press: **`l` `u` `,` `i` `n` `o` `s`**
21+
> *(The `m` is located on the `,` key).*
22+
> Sorry for the inconvenience, known issue.
2123
22-
## 🚀 Prerequisites
24+
### How to try it
25+
1. **Get** the ISO (from Releases -> soon or build it yourself).
26+
2. **Flash** it to a USB stick using **BalenaEtcher** or **Ventoy**.
27+
3. **Boot** your computer from the USB stick (also make sure Secure Boot is disabled in your BIOS).
2328

29+
---
30+
31+
## 📦 Included Software (v0.2.1)
32+
33+
LuminOS comes "batteries included", and some default apps for productivity:
34+
35+
* **Desktop:** KDE Plasma (Dark Theme).
36+
* **AI:** **Lumin** (powered by Ollama + Llama 3) - 100% Local & Offline.
37+
* **Productivity:** **OnlyOffice Desktop Editors** (Word, Excel, PowerPoint compatible).
38+
* **Multimedia:** **VLC Media Player** + Full Codec Pack (h.264, mp3, and more...).
39+
* **System:** **Timeshift** (Backups), **Flatpak** (App Store), **Firefox** (you guessed it, web borwser).
40+
41+
---
42+
43+
## 🏗️ Build It Yourself
44+
45+
We use a transparent, manual build process for good stability.
46+
47+
### Prerequisites
2448
* Host: **Ubuntu 24.04 LTS** or **Debian 12+**.
2549
* Disk Space: ~30 GB free.
2650
* RAM: 8 GB minimum.
27-
* `sudo` privileges.
51+
* `sudo` privileges
2852

29-
## 🛠️ Build Instructions
53+
### Build Instructions
3054

3155
1. **Clone the repository:**
3256
```bash
@@ -40,11 +64,18 @@ The master script `build.sh` orchestrates the entire pipeline:
4064
```
4165

4266
3. **Retrieve the ISO:**
43-
The final image `LuminOS-0.2-amd64.iso` will be generated in the project folder (called build-scripts probably)
67+
The final image `LuminOS-0.2.1-amd64.iso` will be generated in the project folder.
68+
69+
---
4470

45-
## 🤖 About Lumin (AI)
71+
## 🤖 Architecture Overview
4672

47-
LuminOS v0.2 integrates a local AI based on Llama 3. The model is prepared during the build. On the first boot of the installed OS, a background service finalizes the setup automatically.
73+
1. **AI Prep:** Downloads Ollama and Llama 3 on the host to ensure integrity.
74+
2. **Bootstrap:** Creates a pristine Debian Trixie base.
75+
3. **Injection:** Copies scripts, assets, and AI models into the system.
76+
4. **Customization:** Installs Kernel, Desktop, Themes, and Software via chroot hooks.
77+
5. **Assembly:** Compresses the filesystem (SquashFS) and generates a Hybrid ISO.
4878

4979
---
50-
**License:** GPL-3.0 :)
80+
**License:** GPL-3.0
81+
*Built with <3*

0 commit comments

Comments
 (0)