Create README.md

README.md

@@ -0,0 +1,104 @@
+---
+license: mit
+language:
+- en
+base_model:
+- google/gemma-2-2b-it
+pipeline_tag: text-generation
+---
+
+# RemiAI Open Source Framework
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Build: Electron](https://img.shields.io/badge/Build-Electron-blue.svg)](https://www.electronjs.org/)
+[![Model: GGUF](https://img.shields.io/badge/Model-GGUF-green.svg)](https://huggingface.co/)
+
+**A "No-Setup" Local AI Framework for Students**
+
+This project is an open-source, offline AI chat application designed for students and colleges. It allows you to run powerful LLMs (like Llama 3, Mistral, etc.) on your laptop without needing GPU, internet, Python, or complicated installations.
+
+**Note** - No need any GPU in your laptop to run, it will use the CPU in your laptop for the response generation(inference) and if you want to modify the project code and use another model make sure that your are using the `.gguf` formated weights only, normal weights like `.safetensors` will not supported in this application.
+---
+
+## 🚀 Quick Start (One-Line Command)
+
+If you have Git and Node.js installed, open your terminal (Command Prompt or PowerShell) and run:
+
+`for powershell` 
+```bash 
+git clone https://huggingface.co/remiai3/RemiAI_Framework
+cd RemiAI_Framework
+git lfs install
+git lfs pull
+npm install
+npm start
+```
+
+### ⚠️ IMPORTANT: Git LFS Required
+This repository uses **Git Large File Storage (LFS)** for the AI engine binaries. 
+**If you download the ZIP or clone without LFS, the app will not work (Error: "RemiAI engine missing").**
+
+---
+
+## 💻 Manual Installation
+
+### 1. Requirements
+*   **Node.js**: [Download Here](https://nodejs.org/) (Install the LTS version).
+*   **Git & Git LFS**: [Download Git](https://git-scm.com/) | [Download Git LFS](https://git-lfs.com/)
+*   **Windows Laptop**: (Code includes optimized `.exe` binaries for Windows).
+
+### 2. Download & Setup
+1.  **Download** the project zip (or clone the repo).
+2.  **Extract** the folder.
+3.  **Open Terminal** inside the folder path.
+4.  **Pull Engine Files** (Critical Step):
+    ```bash
+    git lfs install
+    git lfs pull
+    ```
+5.  Run the installer for libraries:
+    ```bash
+    npm install
+    ```
+
+### 3. Run the App
+Simply type:
+```bash
+npm start
+```
+The application will launch, the AI engine will start in the background, and you can begin chatting immediately!
+
+---
+
+## 📦 Features
+
+*   **Zero Python Dependency**: We use compiled binaries (`.dll` and `.exe` included) so you don't need to install Python, PyTorch, or set up virtual environments.
+*   **Plug & Play Models**: Supports `.gguf` format.
+    *   Want a different model? Download any `.gguf` file, rename it to `model.gguf`, and place it in the project root.
+*   **Auto-Optimization**: Automatically detects your CPU features (AVX vs AVX2) to give you the best speed possible.
+*   **Privacy First**: Runs 100% offline. No data leaves your device.
+
+*   **Privacy First**: Runs 100% offline. No data leaves your device.
+
+---
+
+## ❓ Troubleshooting
+
+**Error: "RemiAI Engine Missing"**
+This means you downloaded the "pointer" files (130 bytes) instead of the real engine.
+**Fix**:
+1.  Open terminal in project folder.
+2.  Run `git lfs install`
+3.  Run `git lfs pull`
+4.  Restart the app.
+
+---
+
+## 🛠️ Credits & License
+
+*   **Created By**: RemiAI Team
+*   **License**: MIT License. 
+    *   *You are free to rename, modify, and distribute this application as your own project!*
+
+**Note on Models**: The application will only uses the `.gguf` formated weights only to make it as the CPU friendly run the application without any GPU 
+---