diff --git a/README.md b/README.md index 54c2931..fd3fbad 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,16 @@ --- +**Language**: **en** English + + **zh_CN** 简体中文 + + **zh_TW** 繁體中文 + +------ + +**catalog:** + - [Overview](#overview) - [Features](#features) - [Themes](#themes) diff --git a/docs/language/README_tw.md b/docs/language/README_tw.md new file mode 100644 index 0000000..df7327b --- /dev/null +++ b/docs/language/README_tw.md @@ -0,0 +1,116 @@ +
簡約且美觀的Pomotroid番茄鐘
+ +--- + +**語言切換**:en English + + zh_CN 简体中文 + + zh_TW 繁體中文 + +------ + +**目录** + +- [概述](#overview) +- [功能](#features) + - [主題](#themes) +- [安裝](#install) + - [下載](#download) + - [macOS](#homebrew) + - [Windows](#scoop) + - [Windows](#appget) +- [藍圖(規劃)](#roadmap) +- [開發](#development) + - [配置環境](#build-setup) +- [許可證](#license) + +## 概述 + +Pomotroid是一個簡單且可配置的番茄定時器。它的目的是在提供一種美觀且可靠的軟件來使用番茄工作法關注生產力。 + +Pomotroid還處於早期階段,所以歡迎並感謝反饋和貢獻!:seedling: + +## 功能 + +- 自定義時間和次數(持久進行) +- 迷人的定時器提醒聲音(可選) +- 桌面通知(可選) +- 最小化到托盤(可選) +- 除了預設的幾個主題還包括創建自定義主題的能力 +- 計時器活動日誌記錄 + +### 主題 + +Pomotroid提供了許多主題。它也是主題化的,允許你定制它的外觀。 + +![Screenshots of Pomotroid using various themes](https://rosyrain.oss-cn-hangzhou.aliyuncs.com/img2/202404081638800.png) + +請訪問【主題文檔】 [theme documentation](./docs/themes/themes.md)查看官方主題的完整列表,並獲得創建屬於自己的主題。 + +## 安裝 + +### 下載 + +請從[releases](https://github.com/Splode/pomotroid/releases) 頁面,下載最新版本的Pomotroid番茄鐘。 + +Pomotroid 適用於**Windows**、**Mac OSX**和**Linux**。 + +### Homebrew + +您可以使用 [Homebrew](https://brew.sh) 在**macOS**上安裝Pomotroid: + +```sh +brew install --cask pomotroid +``` + +### Scoop + +您可以使用 [scoop ](https://scoop.sh/)在**Windows**上安裝Pomotroid: + +```sh +scoop install https://raw.githubusercontent.com/Splode/pomotroid/master/pomotroid.json +``` + +### AppGet + +您可以使用 [AppGet](https://appget.net/)在**Windows**上安裝Pomotroid: + +```sh +appget install pomotroid +``` + +## 藍圖 + +:memo: 有關優化和拓展功能的未來規劃: + +- 迷你模式 + +## 開發 + +Pomotroid 是依靠[Vue.js](https://github.com/vuejs/vue), [Electron](https://github.com/electron/electron), 和 [electron-vue](https://github.com/SimulatedGREG/electron-vue)進行開發的。 + +*提示: 根據您的操作系統設置,您可能會在安裝時收到安全警告。這與Pomotroid是一個未簽名(認證)的應用程序有關。你可以通過研究蘋果和微軟的代碼簽名來了解更多。* + +### 配置環境 + +```bash +# 安裝依賴 npm install +npm i + +# 啟動項目(在本機的9080端口進行服務熱加載) +npm run dev + +# 打包項目 +npm run build +``` + +## 許可證 + +MIT © [Christopher Murphy](https://github.com/Splode) \ No newline at end of file diff --git a/docs/language/README_zh.md b/docs/language/README_zh.md new file mode 100644 index 0000000..a5d2263 --- /dev/null +++ b/docs/language/README_zh.md @@ -0,0 +1,116 @@ +简约且美观的Pomotroid番茄钟
+ +--- + +**语言切换**:en English + + zh_CN 简体中文 + + zh_TW 繁體中文 + +------ + +**目录** + +- [概述](#overview) +- [功能](#features) + - [主题](#themes) +- [安装](#install) + - [下载](#download) + - [macOS](#homebrew) + - [Windows](#scoop) + - [Windows](#appget) +- [蓝图(规划)](#roadmap) +- [开发](#development) + - [配置环境](#build-setup) +- [许可证](#license) + +## 概述 + +Pomotroid是一个简单且可配置的番茄定时器。它的目的是在提供一种美观且可靠的软件来使用番茄工作法关注生产率。 + +Pomotroid还处于早期阶段,所以欢迎并感谢反馈和贡献!:seedling: + +## 功能 + +- 自定义时间和次数(持久进行) +- 迷人的定时器提醒声音(可选) +- 桌面通知(可选) +- 最小化到托盘(可选) +- 除了默认的几个主题还包括创建自定义主题的能力 +- 计时器活动日志记录 + +### 主题 + +Pomotroid提供了许多主题。它也是主题化的,允许你定制它的外观。 + +![Screenshots of Pomotroid using various themes](https://rosyrain.oss-cn-hangzhou.aliyuncs.com/img2/202404081638800.png) + +请访问【主题文档】 [theme documentation](./docs/themes/themes.md) 查看官方主题的完整列表,并获得创建属于自己的主题。 + +## 安装 + +### 下载 + +请从[releases](https://github.com/Splode/pomotroid/releases) 页面,下载最新版本的Pomotroid番茄钟。 + +Pomotroid 适用于**Windows**、**Mac OSX**和**Linux**。 + +### Homebrew + +您可以使用 [Homebrew](https://brew.sh) 在**macOS**上安装Pomotroid: + +```sh +brew install --cask pomotroid +``` + +### Scoop + +您可以使用 [scoop ](https://scoop.sh/)在**Windows**上安装Pomotroid: + +```sh +scoop install https://raw.githubusercontent.com/Splode/pomotroid/master/pomotroid.json +``` + +### AppGet + +您可以使用 [AppGet](https://appget.net/)在**Windows**上安装Pomotroid: + +```sh +appget install pomotroid +``` + +## 蓝图 + +:memo: 有关优化和拓展功能的未来规划: + +- 迷你模式 + +## 开发 + +Pomotroid 是依靠[Vue.js](https://github.com/vuejs/vue), [Electron](https://github.com/electron/electron), 和 [electron-vue](https://github.com/SimulatedGREG/electron-vue)进行开发的。 + +*提示: 根据您的操作系统设置,您可能会在安装时收到安全警告。这与Pomotroid是一个未签名(认证)的应用程序有关。你可以通过研究苹果和微软的代码签名来了解更多。* + +### 配置环境 + +```bash +# 安装依赖 npm install +npm i + +# 启动项目(在本机的9080端口进行服务热加载) +npm run dev + +# 打包项目 +npm run build +``` + +## 许可证 + +MIT © [Christopher Murphy](https://github.com/Splode) \ No newline at end of file