Skip to content

Commit 495dbed

Browse files
xiaojunjunxiaojunjun
authored andcommitted
docs: split README into English (README.md) and Traditional Chinese (README.zh-TW.md) with cross-links
1 parent e3ee747 commit 495dbed

File tree

2 files changed

+112
-1
lines changed

2 files changed

+112
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
# QuickNote
44

5-
[English](#en) | [繁體中文](#zh)
5+
[繁體中文](./README.zh-TW.md)
6+
7+
[English](#en)
68

79
![License](https://img.shields.io/badge/license-CC--BY--NC--SA--4.0-blue.svg)
810
![Version](https://img.shields.io/badge/version-0.1.0-brightgreen.svg)

README.zh-TW.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
<div align="center">
2+
3+
# QuickNote (繁體中文版本)
4+
5+
[English](./README.md)
6+
7+
**一款為快速存取與簡易使用而設計的、簡單且輕量的筆記應用程式。**
8+
9+
</div>
10+
11+
---
12+
13+
### **QuickNote 實際操作**
14+
15+
*(建議您在此處放置一個展示應用程式功能的 GIF 動畫,例如:主題切換、建立新筆記、自訂快捷鍵等)*
16+
17+
![QuickNote Demo](https://user-images.githubusercontent.com/.../placeholder.gif)
18+
> *請替換成您應用程式的 GIF 動畫。*
19+
20+
---
21+
22+
## 🚀 主要特色
23+
24+
QuickNote 不僅是另一個文字編輯器。它被精心打造,旨在成為您思維的延伸,幫助您無阻力地捕捉靈感,並提升您的生產力。
25+
26+
### 核心體驗與效能
27+
* ⚡️ **全域即時存取:** 無論您在作業系統的任何角落,都能透過可自訂的全域熱鍵,立即呼叫新筆記或切換工作區。在靈感湧現的瞬間捕捉它,無需離開您當前的工作。
28+
* 💨 **原生級效能,羽量級佔用:** 基於 Rust 後端與 Tauri 核心打造,QuickNote 能即時啟動,並以極低的 CPU 和記憶體佔用率運行。體驗網頁應用無法比擬的原生速度與響應能力。
29+
* 🧠 **智慧置頂,專注不中斷:** 當您使用快捷鍵呼叫 QuickNote 時,它會智慧地將視窗帶至最前並短暫置頂,確保您能立即開始輸入,而不會因焦點切換而丟失視窗。
30+
31+
### 直觀的現代化介面
32+
* 🗂️ **進階分頁管理:** 透過強大的分頁介面組織您的思緒。輕鬆地**拖放**以重新排序分頁、**雙擊以重新命名**,並透過視覺標記 (``) 一目了然地查看未儲存的變更。
33+
* ✍️ **極簡而強大的編輯器:** 一個乾淨、無干擾的書寫環境,配備了如**行號****Tab 縮排**等基本工具,幫助您專注於最重要的事:您的內容。
34+
* 🌓 **動態主題切換:** 在精美的**淺色**與舒適的**深色**主題之間無縫切換。您的選擇將被保存並立即應用,讓整個 UI 適應您的個人偏好。
35+
* 🖼️ **時尚無邊框設計 (macOS):** 在 macOS 上享受現代、統一的美學,具備自訂的無邊框視窗與功能完整的整合式**「紅綠燈」**控制按鈕,帶來真正的原生感受。
36+
* 📂 **拖放開啟檔案:** 只需從桌面或檔案總管中拖曳檔案,並將其放置到 QuickNote 視窗上,即可立即在新分頁中開啟它們。
37+
38+
### 強大的自訂能力
39+
* ⌨️ **完全可配置的全域熱鍵:** 完全掌控您的工作流程,自訂用於建立新筆記、關閉分頁以及顯示/隱藏應用程式視窗的鍵盤快捷鍵。
40+
* ⚙️ **工作流程偏好設定:** 透過設定**預設儲存路徑****預設檔案格式**(如 `.txt``.md`)來簡化您的操作,最大程度地減少重複性動作。
41+
* 🌐 **多國語言介面:** 即時切換**英文****繁體中文**。整個介面,從設定到狀態列,都將立即更新。
42+
43+
### 進階工作流程與生產力
44+
* 💾 **智慧儲存系統:** QuickNote 能聰明地處理儲存。它對現有檔案使用`儲存`,對新的未命名筆記則自動提示`另存新檔...`,確保您不會意外覆蓋錯誤的檔案。
45+
* 🛡️ **未儲存變更保護:** 再也不會丟失您的工作。在關閉有未儲存變更的分頁前,QuickNote 會發出警告並請求您的確認。
46+
* 📦 **智慧型系統匣選單:** 無需開啟視窗即可存取核心功能。系統匣圖示提供「新增筆記」、「儲存」等快速操作,外加一個動態的**「最近關閉的檔案」**列表,讓您一鍵重新開啟。
47+
* 📚 **批次檔案開啟:** 從檔案對話框中一次選取並開啟多個檔案。QuickNote 會將每個檔案整齊地在各自的新分頁中開啟,隨時供您使用。
48+
49+
## 🛠️ 技術棧
50+
51+
| 領域 | 技術 |
52+
| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
53+
| **核心框架** | ![Tauri](https://img.shields.io/badge/Tauri-24C8DB?logo=tauri&logoColor=white) ![Rust](https://img.shields.io/badge/Rust-DEA584?logo=rust&logoColor=white) |
54+
| **前端** | ![Vue.js](https://img.shields.io/badge/Vue.js-4FC08D?logo=vue.js&logoColor=white) ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white) |
55+
| **狀態管理** | ![Pinia](https://img.shields.io/badge/Pinia-FFD700?logo=pinia&logoColor=black) |
56+
| **建置工具** | ![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white) |
57+
58+
## 📦 開始使用
59+
60+
### 環境需求
61+
62+
- [Node.js](https://nodejs.org/en/)
63+
- [Rust](https://www.rust-lang.org/tools/install) 與 Cargo
64+
- 根據您的作業系統,遵循 Tauri 的[環境準備指南](https://tauri.app/v1/guides/getting-started/prerequisites)
65+
66+
### 安裝與執行
67+
68+
1. **複製專案倉庫:**
69+
```bash
70+
git clone https://github.com/kaigii/QuickNote.git
71+
cd QuickNote
72+
```
73+
74+
2. **安裝前端依賴:**
75+
```bash
76+
npm install
77+
```
78+
79+
3. **以開發模式執行:**
80+
```bash
81+
npm run tauri dev
82+
```
83+
84+
4. **建置應用程式:**
85+
```bash
86+
npm run tauri build
87+
```
88+
89+
## 📜 授權條款
90+
91+
本專案採用 **Creative Commons 姓名標示-非商業性-相同方式分享 4.0 國際 (CC BY-NC-SA 4.0)** 授權。
92+
93+
這意味著:
94+
- 您可以自由地**分享****改作**本專案,但僅限於非商業性用途。
95+
- 您必須給予適當的**姓名標示** (Attribution)。
96+
- 您**不得**將本作品用於**商業目的** (NonCommercial)。
97+
- 如果您混合、轉換或基於本作品創作,您必須基於**相同授權條款**來散布您的貢獻 (ShareAlike)。
98+
99+
完整的授權條款請參閱 [LICENSE](LICENSE) 檔案或訪問 [Creative Commons 網站](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh_TW)。
100+
101+
## ❤️ 貢獻
102+
103+
歡迎任何形式的貢獻!無論是回報錯誤、建議新功能,或是提交 Pull Request,我們都非常感謝您的幫助。
104+
105+
1. Fork 本專案
106+
2. 建立您的功能分支 (`git checkout -b feature/AmazingFeature`)
107+
3. 提交您的變更 (`git commit -m 'Add some AmazingFeature'`)
108+
4. 將分支推送到遠端 (`git push origin feature/AmazingFeature`)
109+
5. 建立一個 Pull Request

0 commit comments

Comments
 (0)