Revamp README with open-source documentation and add MIT license

2026-10-23 10:42:20 +08:00 · 2026-08-04 01:07:16 +08:00
parent 3994193130
commit 7246343e9e
2 changed files with 122 additions and 26 deletions
--- a/21
+++ b/21
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Helix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/README.md
+++ b/README.md
@@ -1,50 +1,125 @@
+<p align="center">
+  <img src="https://img.shields.io/badge/version-0.1.0-blue" alt="version">
+  <img src="https://img.shields.io/badge/license-MIT-green" alt="license">
+  <img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey" alt="platform">
+</p>
+
 # Helix

-> 一款 Apple 设计风格的 Git 仓库可视化管理工具，基于 Electron 构建。
+> 🧬 A beautiful, Apple-inspired Git repository manager built with Electron.

-## 特性
+Helix makes Git visual. Browse commit history, manage branches, stage and commit changes, and sync with remotes — all through a clean, native-feeling interface with light &amp; dark themes.

- 可视化提交历史、分支管理、工作区变更
- Stage / Unstage / Commit 工作流
- 分支创建与切换
- Fetch / Pull / Push 远程同步
- 中文 / English 双语界面，一键切换
- MiSans 中文字体优先，自动回退系统字体
- 浅色 / 深色双主题，跟随系统
+<p align="center">
+  <img src="https://raw.githubusercontent.com/TuxMonkey2004/Helix/main/.github/screenshot.png" alt="Helix Screenshot" width="800" style="border-radius: 12px; box-shadow: 0 8px 30px rgba(0,0,0,0.12);" />
+</p>

-## 技术栈
+---

- **Electron** 43 — 跨平台桌面框架
- **Vanilla JS** — 零框架依赖
- **Apple Design** — 弹簧动画、半透明材质、SF Pro / MiSans 字体体系
+## ✨ Features

-## 运行
+- **📜 Visual Commit History** — Browse commits with graph, author, date, and message at a glance
+- **🌿 Branch Management** — Create, switch, and track branches with upstream status
+- **📝 Smart Staging** — Stage / unstage individual files, view diffs, and craft clean commits
+- **🔄 Remote Sync** — Fetch, pull, and push with a single click
+- **🌐 i18n** — Full Chinese &amp; English interface, toggle instantly
+- **🎨 Themes** — Light &amp; dark mode, auto-follows system preference
+- **🪟 Frameless Window** — Custom title bar with native-feeling controls
+- **⚡ Zero Dependencies** — Vanilla JavaScript renderer, no React/Vue/Angular
+
+## 📥 Download
+
+Prebuilt binaries are available on the [Releases](https://github.com/TuxMonkey2004/Helix/releases) page.
+
+| Platform | Package |
+|----------|---------|
+| 🪟 Windows | `Helix-Setup-x.x.x.exe` (installer) or `Helix-x.x.x.exe` (portable) |
+| 🍎 macOS | `Helix-x.x.x.dmg` (Intel) or `Helix-x.x.x-arm64.dmg` (Apple Silicon) |
+| 🐧 Linux | `Helix-x.x.x.AppImage` or `Helix_x.x.x_amd64.deb` |
+
+> Requires **Git** to be installed on your system.
+
+## 🚀 Quick Start
+
+### Run from source

 ```bash
+git clone https://github.com/TuxMonkey2004/Helix.git
+cd Helix
 npm install
 npm start
 ```

-## 构建
+### Build installers

 ```bash
-# Windows 安装包
-npm run build
+# Platform-specific
+npm run build:win      # Windows (.exe)
+npm run build:mac      # macOS (.dmg)
+npm run build:linux    # Linux (.AppImage, .deb)

-# Windows 便携版
-npm run build:portable
+# All platforms
+npm run build:all
 ```

-## 项目结构
+## 🧱 Tech Stack
+
+| Layer | Technology |
+|-------|------------|
+| Framework | Electron 43 |
+| Renderer | Vanilla JS + CSS Custom Properties |
+| Typography | SF Pro / MiSans font stack |
+| Design | Apple Human Interface Guidelines |
+| Build | electron-builder |
+
+## 📁 Project Structure

 ```
 Helix/
-├── main.js          # Electron 主进程，Git 操作
-├── preload.js       # 安全 IPC 桥接
+├── main.js              # Electron main process — Git IPC, window management
+├── preload.js           # Secure context bridge (contextIsolation)
 ├── package.json
+├── .github/
+│   └── workflows/
+│       └── build.yml    # CI/CD — cross-platform build & release
 └── src/
-    ├── index.html   # 界面布局
-    ├── styles.css   # Apple 设计系统样式
-    ├── i18n.js      # 中英文翻译
-    └── renderer.js  # 渲染逻辑
+    ├── index.html       # Application layout
+    ├── styles.css       # Apple-inspired design system
+    ├── i18n.js          # zh-CN / en translations
+    └── renderer.js      # UI logic, commit graph, diff viewer
 ```
+
+## 🧪 Development
+
+```bash
+# Start with DevTools open
+npm run dev
+
+# Lint (coming soon)
+# npm run lint
+
+# Test (coming soon)
+# npm test
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Here's how:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feat/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feat/amazing-feature`)
+5. Open a Pull Request
+
+Please keep the code style consistent — no framework dependencies in the renderer.
+
+## 📄 License
+
+MIT © [Helix](https://github.com/TuxMonkey2004/Helix)
+
+---
+
+<p align="center">
+  <sub>Built with ❤️ for developers who appreciate good design.</sub>
+</p>