diff --git a/README.md b/README.md index 8ed8b49..da0128d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@
-# Local AI Image Generator +# 🖼️ Local AI Image Generator ### A fully self-contained, offline-first AI Art Studio for Windows +[![Platform: Windows](https://img.shields.io/badge/Platform-Windows-0078D6?logo=windows&logoColor=white&style=for-the-badge)](https://github.com) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](LICENSE) +[![Build: v1.0.0](https://img.shields.io/badge/Release-v1.0.0-success?style=for-the-badge)](https://github.com) +[![Engine: stable--diffusion.cpp](https://img.shields.io/badge/Engine-stable--diffusion.cpp-orange?style=for-the-badge)](https://github.com/leejet/stable-diffusion.cpp) +--- +[🚀 Quick Start](#-quick-start) • [✨ Features](#-features) • [📸 Screenshots](#-screenshots) • [📂 Project Structure](#-project-structure) • [📦 Adding Models](#-adding-models-required) • [🛠️ Troubleshooting](#%EF%B8%8F-troubleshooting) +--- + +Local AI Studio Dashboard
@@ -42,31 +51,31 @@ Open **`http://localhost:1420`** in your default web browser, select your model, @@ -74,11 +83,24 @@ Open **`http://localhost:1420`** in your default web browser, select your model, --- +## 📸 Screenshots + +### Model Library Manager +Allows downloading recommended weights or importing custom files directly through the UI. +Model Library Screen + +### Inference & Hardware Constraints +Adjust parameters, resolution aspect-ratios, and hardware backend options in one place. +Image Constraints Settings + +--- + ## 🏗️ Project Structure ``` local-ai-image-generator/ ├── start.bat # main double-click launcher +├── LICENSE # MIT Open Source license ├── .gitignore ├── README.md │ @@ -100,6 +122,33 @@ local-ai-image-generator/ --- +## 📦 First-Run Setup Stages + +When launching for the first time, `scripts/setup.ps1` runs automatically in your console window through 4 stages: + +```mermaid +graph TD + A[Launch start.bat] --> B[Stage 1: Setup Portable Node.js] + B --> C[Stage 2: Scan GPU & Download CUDA / Vulkan Binary] + C --> D[Stage 3: Install Frontend NPM Dependencies] + D --> E[Stage 4: Compile React UI into dist/] + E --> F[Open Browser: localhost:1420] +``` + +--- + +## 📥 Adding Models (Required) + +> [!IMPORTANT] +> **This repository does not ship with pre-downloaded AI weights** due to their large file sizes (2 GB to 12 GB+). The `app/models/` folder will be empty on your first start. You must add at least one model before generating. + +You can import weights using **three simple options**: + +1. **Curated Library:** Navigate to the **Model Manager** tab in the dashboard and click **Download** next to any of our pre-configured models (e.g. *DreamShaper 8* for SD 1.5 speed, or *Juggernaut XL* for SDXL realism). +2. **Download URL:** Paste any direct download link to a GGUF/Safetensors weights file (e.g. from Civitai or Hugging Face) into the Model Manager URL box. +3. **Manual Import:** Move your existing `.safetensors`, `.gguf`, or `.ckpt` weights files directly into the `app/models/` directory. + +--- ## 🖥️ GPU Compatibility Matrix diff --git a/assets/dashboard.png b/assets/dashboard.png new file mode 100644 index 0000000..10ebfb5 Binary files /dev/null and b/assets/dashboard.png differ diff --git a/assets/models.png b/assets/models.png new file mode 100644 index 0000000..edf8a96 Binary files /dev/null and b/assets/models.png differ diff --git a/assets/settings.png b/assets/settings.png new file mode 100644 index 0000000..f57cadc Binary files /dev/null and b/assets/settings.png differ
-

100% Offline & Private

+

🔒 100% Offline & Private

All inference runs entirely on your local GPU/CPU. Your prompts, images, and data never leave your computer.

-

Auto-Detected GPU Acceleration

+

🚀 Auto-Detected GPU Acceleration

Seamlessly detects and configures **CUDA** for Nvidia cards, or falls back to the high-performance **Vulkan** engine for AMD & Intel Arc GPUs.

-

No Global Dependencies

+

📦 No Global Dependencies

Zero system footprint. Node.js is downloaded as a portable binary into a sandbox folder, leaving your environment paths untouched.

-

Dynamic Backend Controller

+

🎛️ Dynamic Backend Controller

A native Node.js process manager hosts the React frontend, streams system telemetry, manages downloads, and handles inference server lifecycles.

-

Real-time Hardware Telemetry

+

📊 Real-time Hardware Telemetry

Monitor your PC's real-time CPU, RAM, GPU, and VRAM utilization directly inside the workspace UI.

-

Drag & Drop Model Importing

+

📁 Drag & Drop Model Importing

Upload local model files from other folders on your PC or download weights directly from Hugging Face via the built-in UI downloader.