|
| 1 | +<div align="center"> |
| 2 | + |
| 3 | +# QuickNote |
| 4 | + |
| 5 | +[English] | [[繁體中文](#-quicknote-繁體中文版本)] |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +**A simple, fast, and lightweight note-taking application designed for quick access and ease of use.** |
| 14 | + |
| 15 | +</div> |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +### ✨ **QuickNote in Action** |
| 20 | + |
| 21 | +*(建議您在此處放置一個展示應用程式功能的 GIF 動畫，例如：主題切換、建立新筆記、自訂快捷鍵等)* |
| 22 | + |
| 23 | + |
| 24 | +> *Replace this with a GIF of your application.* |
| 25 | +
|
| 26 | +--- |
| 27 | + |
| 28 | +## 🚀 Key Features |
| 29 | + |
| 30 | +QuickNote isn't just another text editor. It's meticulously crafted to be an extension of your mind, ready to capture thoughts frictionlessly and boost your productivity. |
| 31 | + |
| 32 | +### Core Experience & Performance |
| 33 | +* ⚡️ **Instant Global Access:** Summon a new note or toggle your workspace from anywhere in your OS with customizable global hotkeys. Capture ideas the moment they strike, without ever leaving your current context. |
| 34 | +* 💨 **Native Performance, Feather-light Footprint:** Built with a Rust backend and a Tauri core, QuickNote launches instantly and runs with minimal CPU and memory usage. Experience native speed and responsiveness that web-based apps can't match. |
| 35 | +* 🧠 **Focus-Aware Activation:** When you summon QuickNote via a shortcut, it intelligently brings itself to the foreground and stays on top temporarily, ensuring you can start typing immediately without the window disappearing. |
| 36 | + |
| 37 | +### Intuitive & Modern Interface |
| 38 | +* 🗂️ **Advanced Tab Management:** Organize your thoughts with a powerful tabbed interface. Effortlessly **drag-and-drop** to reorder tabs, **double-click to rename**, and see unsaved changes at a glance with a visual indicator (`•`). |
| 39 | +* ✍️ **Minimalist yet Powerful Editor:** A clean, distraction-free writing environment featuring essential tools like **line numbers** and proper **tab indentation** support, helping you focus on what matters: your content. |
| 40 | +* 🌓 **Dynamic Theming:** Seamlessly switch between a beautiful **Light** and a comfortable **Dark** theme. Your choice is saved and applied instantly, adapting the entire UI to your preference. |
| 41 | +* 🖼️ **Sleek Frameless Design (macOS):** Enjoy a modern, unified aesthetic on macOS with a custom frameless window and fully functional, integrated **"traffic light"** controls for a truly native feel. |
| 42 | +* 📂 **Drag & Drop to Open:** Simply drag files from your desktop or file explorer and drop them onto the QuickNote window to open them in new tabs instantly. |
| 43 | + |
| 44 | +### Powerful Customization |
| 45 | +* ⌨️ **Fully Configurable Global Hotkeys:** Take full control of your workflow by customizing the keyboard shortcuts for creating a new note, closing a tab, and showing/hiding the application window. |
| 46 | +* ⚙️ **Workflow Preferences:** Streamline your process by setting a **default save path** for new notes and choosing a **default file format** (`.txt`, `.md`, etc.), minimizing repetitive actions. |
| 47 | +* 🌐 **Multi-Language Interface:** Switch between **English** and **Traditional Chinese** on-the-fly. The entire UI, from settings to status bar, will update instantly. |
| 48 | + |
| 49 | +### Advanced Workflow & Productivity |
| 50 | +* 💾 **Smart Save System:** QuickNote is smart about saving. It uses `Save` for existing files and automatically prompts `Save As...` for new, untitled notes, ensuring you never accidentally overwrite the wrong file. |
| 51 | +* 🛡️ **Unsaved Changes Protection:** Never lose your work again. QuickNote will warn you and ask for confirmation before closing a tab with unsaved changes. |
| 52 | +* 📦 **Intelligent System Tray Menu:** Access core functions without even opening the window. The tray icon provides quick actions for "New Note", "Save", and more, plus a dynamic list of **Recently Closed Files** for one-click reopening. |
| 53 | +* 📚 **Batch File Opening:** Select and open multiple files at once from the file dialog. QuickNote will neatly open each file in its own new tab, ready for you to work on. |
| 54 | + |
| 55 | +## 🛠️ Tech Stack |
| 56 | + |
| 57 | +| Area | Technology | |
| 58 | +| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 59 | +| **Core** |   | |
| 60 | +| **Frontend** |   | |
| 61 | +| **State** |  | |
| 62 | +| **Build** |  | |
| 63 | + |
| 64 | +## 📦 Getting Started |
| 65 | + |
| 66 | +### Prerequisites |
| 67 | + |
| 68 | +- [Node.js](https://nodejs.org/en/) |
| 69 | +- [Rust](https://www.rust-lang.org/tools/install) and Cargo |
| 70 | +- Follow the Tauri [prerequisites guide](https://tauri.app/v1/guides/getting-started/prerequisites) for your specific OS. |
| 71 | + |
| 72 | +### Installation & Running |
| 73 | + |
| 74 | +1. **Clone the repository:** |
| 75 | + ```bash |
| 76 | + git clone https://github.com/kaigii/QuickNote.git |
| 77 | + cd QuickNote |
| 78 | + ``` |
| 79 | + |
| 80 | +2. **Install frontend dependencies:** |
| 81 | + ```bash |
| 82 | + npm install |
| 83 | + ``` |
| 84 | + |
| 85 | +3. **Run in development mode:** |
| 86 | + ```bash |
| 87 | + npm run tauri dev |
| 88 | + ``` |
| 89 | + |
| 90 | +4. **Build the application:** |
| 91 | + ```bash |
| 92 | + npm run tauri build |
| 93 | + ``` |
| 94 | + |
| 95 | +## 📜 License |
| 96 | + |
| 97 | +This project is licensed under the **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)**. |
| 98 | + |
| 99 | +This means: |
| 100 | +- You are free to **share** and **adapt** the material for non-commercial purposes. |
| 101 | +- You must give appropriate **credit** (Attribution). |
| 102 | +- You may **not** use the material for **commercial purposes** (NonCommercial). |
| 103 | +- If you remix, transform, or build upon the material, you must distribute your contributions under the **same license** (ShareAlike). |
| 104 | + |
| 105 | +For the full license text, see [LICENSE](LICENSE) or visit the [Creative Commons website](https://creativecommons.org/licenses/by-nc-sa/4.0/). |
| 106 | + |
| 107 | +## ❤️ Contributing |
| 108 | + |
| 109 | +Contributions are welcome! Whether it's reporting a bug, suggesting a feature, or submitting a pull request, your help is appreciated. |
| 110 | +
|
| 111 | +1. Fork the Project |
| 112 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 113 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 114 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 115 | +5. Open a Pull Request |
| 116 | +
|
| 117 | +--- |
| 118 | +--- |
| 119 | +
|
| 120 | +## QuickNote (繁體中文版本) |
| 121 | +
|
| 122 | +<div align="center"> |
| 123 | +
|
| 124 | +**一款為快速存取與簡易使用而設計的、簡單且輕量的筆記應用程式。** |
| 125 | +
|
| 126 | +</div> |
| 127 | +
|
| 128 | +--- |
| 129 | +
|
| 130 | +### ✨ **QuickNote 實際操作** |
| 131 | +
|
| 132 | +*(建議您在此處放置一個展示應用程式功能的 GIF 動畫，例如：主題切換、建立新筆記、自訂快捷鍵等)* |
| 133 | +
|
| 134 | + |
| 135 | +> *請替換成您應用程式的 GIF 動畫。* |
| 136 | +
|
| 137 | +--- |
| 138 | +
|
| 139 | +## 🚀 主要特色 |
| 140 | +
|
| 141 | +QuickNote 不僅是另一個文字編輯器。它被精心打造，旨在成為您思維的延伸，幫助您無阻力地捕捉靈感，並提升您的生產力。 |
| 142 | +
|
| 143 | +### 核心體驗與效能 |
| 144 | +* ⚡️ **全域即時存取：** 無論您在作業系統的任何角落，都能透過可自訂的全域熱鍵，立即呼叫新筆記或切換工作區。在靈感湧現的瞬間捕捉它，無需離開您當前的工作。 |
| 145 | +* 💨 **原生級效能，羽量級佔用：** 基於 Rust 後端與 Tauri 核心打造，QuickNote 能即時啟動，並以極低的 CPU 和記憶體佔用率運行。體驗網頁應用無法比擬的原生速度與響應能力。 |
| 146 | +* 🧠 **智慧置頂，專注不中斷：** 當您使用快捷鍵呼叫 QuickNote 時，它會智慧地將視窗帶至最前並短暫置頂，確保您能立即開始輸入，而不會因焦點切換而丟失視窗。 |
| 147 | +
|
| 148 | +### 直觀的現代化介面 |
| 149 | +* 🗂️ **進階分頁管理：** 透過強大的分頁介面組織您的思緒。輕鬆地**拖放**以重新排序分頁、**雙擊以重新命名**，並透過視覺標記 (`•`) 一目了然地查看未儲存的變更。 |
| 150 | +* ✍️ **極簡而強大的編輯器：** 一個乾淨、無干擾的書寫環境，配備了如**行號**和**Tab 縮排**等基本工具，幫助您專注於最重要的事：您的內容。 |
| 151 | +* 🌓 **動態主題切換：** 在精美的**淺色**與舒適的**深色**主題之間無縫切換。您的選擇將被保存並立即應用，讓整個 UI 適應您的個人偏好。 |
| 152 | +* 🖼️ **時尚無邊框設計 (macOS)：** 在 macOS 上享受現代、統一的美學，具備自訂的無邊框視窗與功能完整的整合式**「紅綠燈」**控制按鈕，帶來真正的原生感受。 |
| 153 | +* 📂 **拖放開啟檔案：** 只需從桌面或檔案總管中拖曳檔案，並將其放置到 QuickNote 視窗上，即可立即在新分頁中開啟它們。 |
| 154 | +
|
| 155 | +### 強大的自訂能力 |
| 156 | +* ⌨️ **完全可配置的全域熱鍵：** 完全掌控您的工作流程，自訂用於建立新筆記、關閉分頁以及顯示/隱藏應用程式視窗的鍵盤快捷鍵。 |
| 157 | +* ⚙️ **工作流程偏好設定：** 透過設定**預設儲存路徑**與**預設檔案格式**（如 `.txt`、`.md`）來簡化您的操作，最大程度地減少重複性動作。 |
| 158 | +* 🌐 **多國語言介面：** 即時切換**英文**與**繁體中文**。整個介面，從設定到狀態列，都將立即更新。 |
| 159 | +
|
| 160 | +### 進階工作流程與生產力 |
| 161 | +* 💾 **智慧儲存系統：** QuickNote 能聰明地處理儲存。它對現有檔案使用`儲存`，對新的未命名筆記則自動提示`另存新檔...`，確保您不會意外覆蓋錯誤的檔案。 |
| 162 | +* 🛡️ **未儲存變更保護：** 再也不會丟失您的工作。在關閉有未儲存變更的分頁前，QuickNote 會發出警告並請求您的確認。 |
| 163 | +* 📦 **智慧型系統匣選單：** 無需開啟視窗即可存取核心功能。系統匣圖示提供「新增筆記」、「儲存」等快速操作，外加一個動態的**「最近關閉的檔案」**列表，讓您一鍵重新開啟。 |
| 164 | +* 📚 **批次檔案開啟：** 從檔案對話框中一次選取並開啟多個檔案。QuickNote 會將每個檔案整齊地在各自的新分頁中開啟，隨時供您使用。 |
| 165 | +
|
| 166 | +## 🛠️ 技術棧 |
| 167 | +
|
| 168 | +| 領域 | 技術 | |
| 169 | +| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 170 | +| **核心框架** |   | |
| 171 | +| **前端** |   | |
| 172 | +| **狀態管理** |  | |
| 173 | +| **建置工具** |  | |
| 174 | +
|
| 175 | +## 📦 開始使用 |
| 176 | +
|
| 177 | +### 環境需求 |
| 178 | +
|
| 179 | +- [Node.js](https://nodejs.org/en/) |
| 180 | +- [Rust](https://www.rust-lang.org/tools/install) 與 Cargo |
| 181 | +- 根據您的作業系統，遵循 Tauri 的[環境準備指南](https://tauri.app/v1/guides/getting-started/prerequisites)。 |
| 182 | +
|
| 183 | +### 安裝與執行 |
| 184 | +
|
| 185 | +1. **複製專案倉庫：** |
| 186 | + ```bash |
| 187 | + git clone https://github.com/kaigii/QuickNote.git |
| 188 | + cd QuickNote |
| 189 | + ``` |
| 190 | +
|
| 191 | +2. **安裝前端依賴：** |
| 192 | + ```bash |
| 193 | + npm install |
| 194 | + ``` |
| 195 | +
|
| 196 | +3. **以開發模式執行：** |
| 197 | + ```bash |
| 198 | + npm run tauri dev |
| 199 | + ``` |
| 200 | +
|
| 201 | +4. **建置應用程式：** |
| 202 | + ```bash |
| 203 | + npm run tauri build |
| 204 | + ``` |
| 205 | +
|
| 206 | +## 📜 授權條款 |
| 207 | +
|
| 208 | +本專案採用 **Creative Commons 姓名標示-非商業性-相同方式分享 4.0 國際 (CC BY-NC-SA 4.0)** 授權。 |
| 209 | +
|
| 210 | +這意味著： |
| 211 | +- 您可以自由地**分享**與**改作**本專案，但僅限於非商業性用途。 |
| 212 | +- 您必須給予適當的**姓名標示** (Attribution)。 |
| 213 | +- 您**不得**將本作品用於**商業目的** (NonCommercial)。 |
| 214 | +- 如果您混合、轉換或基於本作品創作，您必須基於**相同授權條款**來散布您的貢獻 (ShareAlike)。 |
| 215 | +
|
| 216 | +完整的授權條款請參閱 [LICENSE](LICENSE) 檔案或訪問 [Creative Commons 網站](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh_TW)。 |
| 217 | +
|
| 218 | +## ❤️ 貢獻 |
| 219 | +
|
| 220 | +歡迎任何形式的貢獻！無論是回報錯誤、建議新功能，或是提交 Pull Request，我們都非常感謝您的幫助。 |
| 221 | +
|
| 222 | +1. Fork 本專案 |
| 223 | +2. 建立您的功能分支 (`git checkout -b feature/AmazingFeature`) |
| 224 | +3. 提交您的變更 (`git commit -m 'Add some AmazingFeature'`) |
| 225 | +4. 將分支推送到遠端 (`git push origin feature/AmazingFeature`) |
| 226 | +5. 建立一個 Pull Request |
0 commit comments