feat: Make app fully portable
- Add tauri-plugin-store for portable data storage - Implement portable data directory (TypoGenie-Data/ next to EXE) - Configure Rust backend to use EXE-relative paths - Add store permissions for persistent settings - Update README with portable badges and documentation - Document how to build and use the portable EXE - Zero registry, zero AppData, fully self-contained
This commit is contained in:
51
README.md
51
README.md
@@ -25,6 +25,11 @@
|
||||
<img src="https://img.shields.io/badge/Desktop_App-Windows%20%7C%20macOS%20%7C%20Linux-blue?style=for-the-badge" alt="Desktop Apps" />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<img src="https://img.shields.io/badge/Portable-No_Installation_Required-success?style=for-the-badge&logo=windows-terminal&logoColor=white" alt="Portable" />
|
||||
<img src="https://img.shields.io/badge/Zero_Registry-Leave_No_Trace-orange?style=for-the-badge" alt="No Registry" />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<img src="https://img.shields.io/badge/license-MIT-green?style=flat-square" alt="License" />
|
||||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square" alt="PRs Welcome" />
|
||||
@@ -146,12 +151,29 @@ Every style includes meticulously configured:
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Option 1: Download Desktop App (Recommended)
|
||||
### Option 1: Portable Download (Recommended) 🎒
|
||||
|
||||
Pre-built binaries coming soon for:
|
||||
- 🪟 **Windows** (.msi, .exe)
|
||||
- 🍎 **macOS** (.dmg, .app)
|
||||
- 🐧 **Linux** (.deb, .rpm, .AppImage)
|
||||
**TypoGenie is fully portable** — no installation, no registry entries, no files scattered across your system.
|
||||
|
||||
Just download and run:
|
||||
- 🪟 **Windows**: `TypoGenie.exe` — Single executable, runs immediately
|
||||
- 🍎 **macOS**: `TypoGenie.app` — Drag and run
|
||||
- 🐧 **Linux**: `TypoGenie.AppImage` — Make executable and run
|
||||
|
||||
**How it works:**
|
||||
```
|
||||
📁 Your Folder/
|
||||
├── 🚀 TypoGenie.exe ← Run this
|
||||
└── 📂 TypoGenie-Data/ ← Auto-created on first run
|
||||
├── config.json ← Your settings
|
||||
└── cache/ ← Temporary files
|
||||
```
|
||||
|
||||
✅ **No installer** — Just double-click the EXE
|
||||
✅ **No registry** — Windows registry untouched
|
||||
✅ **No AppData** — Everything stays in the same folder
|
||||
✅ **USB-friendly** — Run from a thumb drive anywhere
|
||||
✅ **Easy backup** — Copy the whole folder, done
|
||||
|
||||
### Option 2: Build from Source
|
||||
|
||||
@@ -189,7 +211,24 @@ npm run desktop
|
||||
npm run desktop:build
|
||||
```
|
||||
|
||||
The built apps will be in `src-tauri/target/release/bundle/`
|
||||
**Build outputs:**
|
||||
|
||||
| Platform | Output Location | Result |
|
||||
|----------|----------------|--------|
|
||||
| **Windows** | `src-tauri/target/release/typogenie.exe` | ⚡ **Portable EXE** — Run immediately, no install |
|
||||
| **Windows** | `src-tauri/target/release/bundle/nsis/*.exe` | 📦 NSIS Installer (optional) |
|
||||
| **macOS** | `src-tauri/target/release/bundle/dmg/*.dmg` | 🍎 DMG with App bundle |
|
||||
| **Linux** | `src-tauri/target/release/bundle/appimage/*.AppImage` | 🐧 Portable AppImage |
|
||||
|
||||
**For the truly portable Windows experience:**
|
||||
```bash
|
||||
# After building, grab the raw EXE:
|
||||
copy src-tauri\target\release\typogenie.exe "C:\Path\To\Your\Portable\Folder\"
|
||||
|
||||
# Run it:
|
||||
"C:\Path\To\Your\Portable\Folder\typogenie.exe"
|
||||
# Creates TypoGenie-Data/ folder next to EXE automatically
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
|
||||
Reference in New Issue
Block a user