diff --git a/README.md b/README.md index 067974f..3e48da7 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,249 @@ -# LuminOS Build Scripts +# 🌌 LuminOS Build Scripts -[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)]() [![Version](https://img.shields.io/badge/version-v0.2.1-blue)]() +![Build Status](https://img.shields.io/badge/build-stable-brightgreen) +![Version](https://img.shields.io/badge/version-v0.3-blue) +![License](https://img.shields.io/badge/license-GPL--3.0-red) +![Platform](https://img.shields.io/badge/platform-Debian%2013-lightgrey) +![AI](https://img.shields.io/badge/AI-Local%20LLM-purple) +![Privacy](https://img.shields.io/badge/privacy-100%25%20Local-success) -Welcome to the official repository for **LuminOS**. +Welcome to the **official build system for LuminOS**. -**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 +**LuminOS** is a **privacy-focused AI operating system** built on **Debian 13 (Trixie)** designed for users who want **powerful AI tools running locally without cloud dependency**. + +The system integrates **Lumin**, a fully offline AI assistant powered by **Ollama + local LLM models**, while maintaining the transparency and stability of Debian. + +--- + +# 🚀 Vision + +The goal of **LuminOS** is simple: + +> Build the **first truly transparent AI operating system** where AI runs **locally, securely, and privately**. + +No tracking. +No cloud dependency. +Just **pure local intelligence**. --- -## 💿 Getting Started (Live ISO) +# 💿 Try LuminOS ### Default Credentials -If you boot the ISO, use these credentials to log in: -* **User:** `liveuser` -* **Password:** `luminos` -> **⚠️ Important for AZERTY Users:** -> The live system boots with a **US (QWERTY)** keyboard layout by default. -> To type "luminos", use the digital keyboard (the one on screen). You'll find the option in the bottom left corner. Alternatively, you can also press: **`l` `u` `,` `i` `n` `o` `s`** -> *(The `m` is located on the `,` key).* -> Sorry for the inconvenience... 😅 will fix this. +``` +User: liveuser +Password: luminos +``` + +⚠️ **Keyboard Notice** + +The live ISO uses **US (QWERTY)** layout by default. + +If you use **AZERTY**, type the password like this: + +``` +l u , i n o s +``` + +(the `m` key is on the `,` position) + +--- + +# 📦 Included Software + +LuminOS ships with carefully selected software. + +### Desktop + +• **KDE Plasma (Dark Theme)** +• Modern UI +• Lightweight configuration + +### AI Stack + +• **Lumin AI Assistant** +• **Ollama Runtime** +• **Local LLM models** +• Fully **offline capable** + +### Productivity + +• **OnlyOffice Desktop Editors** +• Word / Excel / PowerPoint compatible + +### Multimedia + +• **VLC Media Player** +• Full codec support (h264, mp3, etc) + +### System Tools + +• **Timeshift** – system restore +• **Flatpak** – application store +• **Firefox** – web browser + +--- + +# 🏗️ Architecture + +LuminOS follows a **transparent build pipeline**. + +``` +Host System + │ + ▼ +Bootstrap Debian Base + │ + ▼ +Install Core Packages + │ + ▼ +Inject AI Runtime (Ollama) + │ + ▼ +Install Desktop Environment + │ + ▼ +Apply Customization + │ + ▼ +Compress Filesystem (SquashFS) + │ + ▼ +Generate Bootable Hybrid ISO +``` -### How to try it -1. **Get** the ISO (from Releases -> soon or build it yourself). -2. **Flash** it to a USB stick using **BalenaEtcher** or **Ventoy**. -3. **Boot** your computer from the USB stick (also make sure Secure Boot is disabled in your BIOS). +--- + +# 🛠 Build LuminOS Yourself + +### Requirements + +``` +Host OS: Ubuntu 24.04 LTS or Debian 12+ +RAM: 8GB minimum +Disk Space: 30GB+ +Privileges: sudo +``` --- -## 📦 Included Software +### 1️⃣ Clone Repository -LuminOS comes "batteries included", and some default apps for productivity: +```bash +git clone https://github.com/4LuminOS/build-scripts.git +cd build-scripts +``` -* **Desktop:** KDE Plasma (Dark Theme). -* **AI:** **Lumin** (powered by Ollama + Llama 3) - 100% Local & Offline. -* **Productivity:** **OnlyOffice Desktop Editors** (Word, Excel, PowerPoint compatible). -* **Multimedia:** **VLC Media Player** + Full Codec Pack (h.264, mp3, and more...). -* **System:** **Timeshift** (Backups), **Flatpak** (App Store), **Firefox** (you guessed it, web borwser). +--- + +### 2️⃣ Start Build + +```bash +sudo ./build.sh +``` --- -## 🏗️ Build It Yourself +### 3️⃣ Retrieve ISO -We use a transparent, manual build process for good stability. +After completion: -### Prerequisites -* Host: **Ubuntu 24.04 LTS** or **Debian 12+**. -* Disk Space: ~30 GB free. -* RAM: 8 GB minimum. -* `sudo` privileges +``` +LuminOS-x.x.x-amd64.iso +``` -### Build Instructions +will appear in the project directory. -1. **Clone the repository:** - ```bash - git clone https://github.com/4LuminOS/build-scripts.git - cd build-scripts - ``` +--- -2. **Run the build:** - ```bash - sudo ./build.sh - ``` +# 🤖 AI System + +LuminOS integrates **local AI inference**. + +``` +User + │ + ▼ +Lumin AI Assistant + │ + ▼ +Ollama Runtime + │ + ▼ +Local LLM Model + │ + ▼ +Response +``` + +Benefits: + +• Fully **offline AI** +• **No data leaves your machine** +• **No API cost** +• **Fast inference** -3. **Retrieve the ISO:** - The final image `LuminOS-0.2.1-amd64.iso` will be generated in the project folder. +--- + +# 🛣️ Roadmap + +### Upcoming Improvements + +• Improve automated build system +• Add graphical installer +• Better AI assistant integration +• Reduce ISO size +• Improve hardware compatibility +• GPU acceleration for AI +• Multi-model AI support --- -## 🤖 Architecture Overview +# 🤝 Contributing + +Contributions are welcome. + +You can help by: + +• Improving build scripts +• Fixing bugs +• Optimizing ISO generation +• Improving documentation +• Adding AI features -1. **AI Prep:** Downloads Ollama and Llama 3 on the host to ensure integrity. -2. **Bootstrap:** Creates a pristine Debian Trixie base. -3. **Injection:** Copies scripts, assets, and AI models into the system. -4. **Customization:** Installs Kernel, Desktop, Themes, and Software via chroot hooks. -5. **Assembly:** Compresses the filesystem (SquashFS) and generates a Hybrid ISO. +### Steps + +``` +1 Fork the repository +2 Create a feature branch +3 Commit your changes +4 Open a Pull Request +``` + +--- + +# 📜 License + +This project is licensed under: + +**GPL-3.0 License** + +--- + +# 🌍 LuminOS Mission + +LuminOS aims to become a **next-generation AI operating system** where users can run powerful AI tools **locally, privately, and securely**. + +The long-term goal is to build a **fully transparent AI ecosystem**. --- -**License:** GPL-3.0 -*Built with <3* + +⭐ **If you like the project, consider starring the repository.** + +It helps the project grow and reach more developers. + +``` +Built with ❤️ by the LuminOS Community +```