vndangkhoa/kv-clearnup
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

docs: update README with new features and cross-platform build instructions

Browse source
This commit is contained in:
vndangkhoa 2026-03-10 08:05:29 +07:00
parent eb4a400736
commit d674c89c47
1 changed files with 16 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -5,22 +5,24 @@ A modern, high-performance system optimizer for macOS, built with **Electron**,
![App Screenshot](https://via.placeholder.com/800x500?text=Antigravity+Dashboard)
## Features
- **Flash Clean**: Instantly remove system caches, logs, and trash.
- **Flash Clean**: Instantly remove system caches, logs, Xcode cache, Homebrew cache, and manage Trash with a detailed inspection view.
- **App Uninstaller**: View installed applications, their sizes, and thoroughly remove them along with their associated preference files and caches.
- **Deep Clean**: Scan for large files and heavy folders.
- **Real-time Monitoring**: Track disk usage and category sizes.
- **Universal Binary**: Runs natively on both Apple Silicon (M1/M2/M3) and Intel Macs.
- **High Performance**: Heavy lifting is handled by a compiled Go backend.
- **Native Menubar Integration**: Includes a responsive, monochrome template icon that adapts to macOS light/dark modes perfectly.
- **Cross-Platform**: Runs natively with compiled Go backends on Apple Silicon (M1/M2/M3), Intel Macs, and Windows.
## Prerequisites
- **Node.js** (v18+)
- **Go** (v1.20+)
- **pnpm** (preferred) or npm
- **C Compiler** (gcc/clang, via Xcode Command Line Tools on macOS)
## Development
### 1. Install Dependencies
```bash
npm install
pnpm install
```
### 2. Run in Development Mode
@ -28,28 +30,25 @@ This starts the Go backend (port 36969) and the Vite/Electron frontend concurren
```bash
./start-go.sh
```
*Note: Do not run `npm run dev` directly if you want the backend to work. Use the script.*
*Note: Do not run `pnpm run dev` directly if you want the backend to work. Use the script.*
## Building for Production
To create a distributable `.dmg` file for macOS:
To create distributable release binaries (Universal `.dmg` for macOS, Portable `.exe` for Windows):
### 1. Build the App
```bash
npm run build:mac
# macOS Universal DMG
pnpm run build && pnpm run electron:build && npx electron-builder --mac --universal
# Windows Portable EXE
pnpm run build && pnpm run electron:build && npx electron-builder --win portable --x64
```
This command will:
1. Compile the Go backend for both `amd64` and `arm64`.
2. Create a universal binary using `lipo`.
3. Build the React frontend.
4. Package the Electron app and bundle the backend.
5. Generate a universal `.dmg`.
### 2. Locate the Installer
The output file will be at:
```
release/KV Clearnup-1.0.0-universal.dmg
```
The output files will be automatically placed in the `release/` directory:
- `release/KV Clearnup-1.0.0-universal.dmg` (macOS)
- `release/KV Clearnup 1.0.0.exe` (Windows)
## Running the App
1. **Mount the DMG**: Double-click the `.dmg` file in the `release` folder.