-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
7 changed files
with
55 additions
and
349 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,11 +4,7 @@ | |
| <h2 align="center">wnr</h2> | ||
|
|
||
| <p align="center"> | ||
| <b>The name is an abbr of "Work & Rest". It's a timer app with strong expansibility for computers.</b> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| As a timer app, wnr is simple but useful. | <a href="https://getwnr.com/">中文网站</a> | ||
| <b>A timer app with strong expansibility for computers</b> | <a href="https://getwnr.com/">Website</a> | <a href="https://getwnr.com/zh/">网站中文页面</a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
|
|
@@ -18,92 +14,11 @@ | |
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/RoderickQiu/wnr/blob/master/README.md">English README</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-CN.md">简体中文简介</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-TW.md">正體中文簡介</a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md">Development Guide</a> | ||
| <a href="https://github.com/RoderickQiu/wnr/blob/master/README.md">English README</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-CN.md">简体中文简介</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-TW.md">正體中文簡介</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md">Development Guide</a> | <a href="mailto:[email protected]">Contact Me</a> | ||
| </p> | ||
|
|
||
| <table border="0" align="center"> | ||
| <tr> | ||
| <td align="right"><img src="https://i.loli.net/2020/10/01/D72AIFTGQ49OpYd.png" ></td> | ||
| <td align="left"><img src="https://i.loli.net/2020/10/01/XMiGmRJNwtyf1SY.png" ></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| - modern design | ||
|
|
||
| - multi-platforms support *(currently Windows & macOS)* | ||
|
|
||
| - multi-languages support *(you can help | ||
| to [contribute](https://github.com/RoderickQiu/wnr/blob/master/locales/README.md)!)* | ||
|
|
||
| - multi-monitor support | ||
|
|
||
| - multi-virtual-desktops support | ||
|
|
||
| - portable software available *(currently Windows)* | ||
|
|
||
| - semantic time input | ||
|
|
||
| - work time / rest time settings | ||
|
|
||
| - automatic loops | ||
|
|
||
| - predefined tasks / defaults | ||
|
|
||
| - clear tips for time | ||
|
|
||
| - optional taskname and task notes | ||
|
|
||
| - tray menu | ||
|
|
||
| - alerts for time end | ||
|
|
||
| - full-screen focus mode | ||
|
|
||
| - lock mode / parent control | ||
|
|
||
| - strict rules to prevent users from hacking | ||
|
|
||
| - always-on-top mode | ||
|
|
||
| - auto-start with system | ||
|
|
||
| - auto start task | ||
|
|
||
| - progress bar support | ||
|
|
||
| - hi-dpi support | ||
|
|
||
| - good touchscreen usability | ||
|
|
||
| - dark mode support | ||
|
|
||
| - user-friendly tourguide | ||
|
|
||
| - user-friendly updater | ||
|
|
||
| - infinity mode | ||
|
|
||
| - ... | ||
|
|
||
| This application is being frequently updated, so does this list. | ||
|
|
||
| ## Contact | ||
|
|
||
| - Homepage: [getwnr.com](https://getwnr.com/). | ||
|
|
||
| - Downloads: [Releases](https://github.com/RoderickQiu/wnr/releases/). | ||
|
|
||
| - Need Help: [Go to Help Page](https://getwnr.com/guide/1-basic-usage.html) or [Contact Me](mailto:[email protected]) | ||
| . | ||
|
|
||
| ## Contributing | ||
|
|
||
| I appreciate it if you can help contribute. | ||
|
|
@@ -116,10 +31,6 @@ I appreciate it if you can help contribute. | |
| - If you want to add a new language to | ||
| wnr, [see this guide first](https://github.com/RoderickQiu/wnr/blob/master/locales/README.md). | ||
|
|
||
| ## To-do List | ||
|
|
||
| Please go and see the [GitHub Project](https://github.com/RoderickQiu/wnr/projects/1). | ||
|
|
||
| ## How to Build | ||
|
|
||
| ```shell | ||
|
|
@@ -144,16 +55,12 @@ yarn linux # linux | |
| yarn appimage # linux AppImage | ||
| ``` | ||
|
|
||
| Please note that: | ||
|
|
||
| - Linux version hasn't been tested *(If you are using Linux, you can fix things up yourself and contribute)*. | ||
|
|
||
| For more info about development, go to [** | ||
| DEVELOPMENT_GUIDE**](https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md). | ||
| For more info about development, go | ||
| to **[DEVELOPMENT_GUIDE](https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md)**. | ||
|
|
||
| ## Copyright & Credit | ||
|
|
||
| Copyright (c) 2019-2021 **[Roderick Qiu](https://r-q.name)** and other contributors. All rights reserved. | ||
| Copyright (c) 2019-2022 **[Roderick Qiu](https://r-q.name)** and other contributors. All rights reserved. | ||
|
|
||
| Licensed under the **[MPL 2.0 License](https://github.com/RoderickQiu/wnr/blob/master/LICENSE)**. | ||
|
|
||
|
|
@@ -180,22 +87,13 @@ is also included in every copy of wnr. | |
| - bootstrap, twbs, MIT License. | ||
| - iconfont, ALIMAMA MUX, for license go to [the site](https://www.iconfont.cn/). | ||
| - dotenv, motdotla, BSD-2-Clause License. | ||
| - windows-release, sindresorhus, MIT License. | ||
| - leancloud-storage, leancloud, MIT License. | ||
| - electron-debug, sindresorhus, MIT License. | ||
| - node-fetch, node-fetch, MIT License. | ||
| - node-notifier, mikaelbr, MIT License. | ||
| - popper.js, popperjs, MIT License. | ||
| - schart.js, lin-xin, MIT License. | ||
| - cross-env, kentcdodds, MIT License. | ||
|
|
||
| #### Website / Documents *([wnr-guide](https://github.com/RoderickQiu/wnr-guide), provided | ||
| with [[CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html)] license)* | ||
|
|
||
| - **vuepress, vuejs, MIT License**. | ||
| - vuepress-plugin-sitemap, ekoeryanto, MIT License. | ||
| - vuepress-theme-api, sqrthree, MIT License. | ||
|
|
||
| ### Environment Using | ||
|
|
||
| - **node, nodejs, [License](https://github.com/nodejs/node/blob/master/LICENSE)**. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,117 +4,30 @@ | |
| <h2 align="center">wnr</h2> | ||
|
|
||
| <p align="center"> | ||
| <b>它的名称来源于 "Work & Rest" 的缩写。这是一个拥有高可扩展性的时间管理计算机软件。</b> | ||
| <b>一个拥有高可扩展性的时间管理计算机软件</b> | <a href="https://getwnr.com/">中文网站</a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| 作为一个时间管理软件，wnr 简洁而又实用。| <a href="https://getwnr.com/">中文网站</a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| 下载地址 <i>(Windows & macOS)</i>: <a href="https://github.com/RoderickQiu/wnr/releases">GitHub Release</a> | <a | ||
| 下载地址 <i>(Win/Mac/Linux)</i>: <a href="https://github.com/RoderickQiu/wnr/releases">GitHub Release</a> | <a | ||
| href="https://www.softpedia.com/get/Desktop-Enhancements/Clocks-Time-Management/wnr.shtml">Softpedia | ||
| (Windows)</a> | <a href="https://pan.baidu.com/s/1PDpnEkf-zKQKQIhUTO0ubQ">百度网盘</a>（swh3） | <a href="https://scris.lanzoui.com/b01n0tb4j">蓝奏云高速下载</a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/RoderickQiu/wnr/blob/master/README.md">English README</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-CN.md">简体中文简介</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-TW.md">正體中文簡介</a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md">开发导引文档</a> | ||
| <a href="https://github.com/RoderickQiu/wnr/blob/master/README.md">English README</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-CN.md">简体中文简介</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/README.zh-TW.md">正體中文簡介</a> | <a href="https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md">开发导引文档</a> | <a href="mailto:[email protected]">联系我</a> | ||
| </p> | ||
|
|
||
| <table border="0" align="center"> | ||
| <tr> | ||
| <td align="right"><img src="https://i.loli.net/2020/10/01/lX6Q9uqFNWSUB7k.png" ></td> | ||
| <td align="left"><img src="https://i.loli.net/2020/10/01/d92EyIKFejBrl4w.png" ></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| --- | ||
|
|
||
| ## 特性 | ||
|
|
||
| - 现代的设计 | ||
|
|
||
| - 多平台支持 *（目前支持 Windows & macOS）* | ||
|
|
||
| - 多语言支持 *（你可以 [贡献翻译](https://github.com/RoderickQiu/wnr/blob/master/locales/README.md)！）* | ||
|
|
||
| - 多屏幕支持 | ||
|
|
||
| - 多虚拟桌面支持 | ||
|
|
||
| - 拥有便携版 *（目前支持 Windows）* | ||
|
|
||
| - 用自然语言输入时间 | ||
|
|
||
| - 设置工作时间、休息时间 | ||
|
|
||
| - 自动循环 | ||
|
|
||
| - 提前规划任务和预设方案 | ||
|
|
||
| - 明确的时间提示 | ||
|
|
||
| - 可选的任务名称和备注 | ||
|
|
||
| - 托盘菜单 | ||
|
|
||
| - 时间到时响铃 | ||
|
|
||
| - 全屏专心模式 | ||
|
|
||
| - 锁定模式 / 家长控制 | ||
|
|
||
| - 严格的规则来阻止用户耍小聪明 | ||
|
|
||
| - 置顶模式 | ||
|
|
||
| - 随系统自动启动 | ||
|
|
||
| - 自动开始任务 | ||
|
|
||
| - 进度条 | ||
|
|
||
| - 高分辨率支持 | ||
|
|
||
| - 触摸屏高可用度 | ||
|
|
||
| - 暗黑模式 | ||
|
|
||
| - 用户友好的导览功能 | ||
|
|
||
| - 用户友好的升级功能 | ||
|
|
||
| - 无限循环模式 | ||
|
|
||
| - ... | ||
|
|
||
| 这个软件会经常更新，这个榜单也一样。 | ||
|
|
||
| ## 联系方式 | ||
|
|
||
| - 主页： [getwnr.com](https://getwnr.com/)。 | ||
|
|
||
| - 下载地址： [Releases](https://github.com/RoderickQiu/wnr/releases/)。 | ||
|
|
||
| - 获取帮助： [前往帮助页面](https://getwnr.com/guide/1-basic-usage.html) 或 [联系我](mailto:[email protected])。 | ||
|
|
||
| ## 贡献 | ||
|
|
||
| 非常感谢你的贡献。 | ||
|
|
||
| - 如果你想报告一些期望的特性或漏洞，请随时 [提交 Issue](https://github.com/RoderickQiu/wnr/issues/new)。 | ||
|
|
||
| - 如果你做了些不错的改进，那么请 [提交 Pull Request](https://github.com/RoderickQiu/wnr/pulls)。 | ||
| - 如果你想报告一些期望的特性或漏洞，请随时 [提交 Issue](https://github.com/RoderickQiu/wnr/issues/new) 。 | ||
|
|
||
| - 如果你想为 wnr 添加一种语言的支持， [请先阅读这份指南](https://github.com/RoderickQiu/wnr/blob/master/locales/README.md)。 | ||
| - 如果你做了些不错的改进，那么请 [提交 Pull Request](https://github.com/RoderickQiu/wnr/pulls) 。 | ||
|
|
||
| ## 待办事项 | ||
|
|
||
| 请前往 [GitHub Project](https://github.com/RoderickQiu/wnr/projects/1)。 | ||
| - 如果你想为 wnr 添加一种语言的支持， [请先阅读这份指南](https://github.com/RoderickQiu/wnr/blob/master/locales/README.md) 。 | ||
|
|
||
| ## 如何构建 | ||
|
|
||
|
|
@@ -140,23 +53,19 @@ yarn linux # Linux版本打包 | |
| yarn appimage # linux AppImage打包 | ||
| ``` | ||
|
|
||
| 请注意： | ||
|
|
||
| - Linux 版本还未经测试 *（如果你在使用 Linux，你可以自己尝试修改然后贡献）*。 | ||
|
|
||
| 更多有关wnr的技术细节和开发建议，请查看[**DEVELOPMENT_GUIDE**](https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md)。 | ||
| 更多有关 wnr 的技术细节和开发建议，请查看 **[DEVELOPMENT_GUIDE](https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md)** 。 | ||
|
|
||
| ## 版权和鸣谢 | ||
|
|
||
| 版权所有 (c) 2019-2021 **[Roderick Qiu](https://r-q.name)** 和其他贡献者。保留所有权利。 | ||
| 版权所有 (c) 2019-2022 **[Roderick Qiu](https://r-q.name)** 和其他贡献者。保留所有权利。 | ||
|
|
||
| 使用 **[MPL 2.0 许可证](https://github.com/RoderickQiu/wnr/blob/master/LICENSE)** 进行许可。 | ||
|
|
||
| ### 使用的软件包 | ||
|
|
||
| #### 主程序 | ||
|
|
||
| 完整的许可证文本参见 [这个文件](https://github.com/RoderickQiu/wnr/blob/master/NOTICE.md)，同时也包含在每一份 wnr 的副本中。 | ||
| 完整的许可证文本参见 [这个文件](https://github.com/RoderickQiu/wnr/blob/master/NOTICE.md) ，同时也包含在每一份 wnr 的副本中。 | ||
|
|
||
| - node-shi，[**我自己的项目**](https://www.npmjs.com/package/node-shi) 使用 MIT 许可证。 | ||
| - cmd-or-ctrl，[**另一个我自己的项目**](https://www.npmjs.com/package/cmd-or-ctrl) 使用 MIT 许可证。 | ||
|
|
@@ -172,26 +81,18 @@ yarn appimage # linux AppImage打包 | |
| - electron-builder，electron-userland，MIT 许可证。 | ||
| - jquery，jquery，MIT 许可证。 | ||
| - bootstrap，twbs，MIT 许可证。 | ||
| - iconfont，ALIMAMA MUX，许可证参见 [此网站](https://www.iconfont.cn/)。 | ||
| - iconfont，ALIMAMA MUX，许可证参见 [此网站](https://www.iconfont.cn/) 。 | ||
| - node-md5，pvorb，BSD-3-Clause 许可证。 | ||
| - dotenv，motdotla，BSD-2-Clause 许可证。 | ||
| - windows-release，sindresorhus，MIT 许可证。 | ||
| - leancloud-storage，leancloud，MIT 许可证。 | ||
| - electron-debug，sindresorhus，MIT 许可证。 | ||
| - node-fetch，node-fetch，MIT 许可证。 | ||
| - node-notifier，mikaelbr，MIT 许可证。 | ||
| - popper.js，popperjs，MIT 许可证。 | ||
| - schart.js，lin-xin，MIT 许可证。 | ||
| - cross-env，kentcdodds，MIT 许可证。 | ||
|
|
||
| #### 网站 / 文档 *([wnr-guide](https://github.com/RoderickQiu/wnr-guide)，使用 [[CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html)] 许可证)* | ||
|
|
||
| - **vuepress，vuejs，MIT 许可证**。 | ||
| - vuepress-plugin-sitemap，ekoeryanto，MIT 许可证。 | ||
| - vuepress-theme-api，sqrthree，MIT 许可证。 | ||
|
|
||
| ### 开发环境 | ||
|
|
||
| - **node，nodejs，**[**许可证**](https://github.com/nodejs/node/blob/master/LICENSE)。 | ||
| - **node，nodejs，**[**许可证**](https://github.com/nodejs/node/blob/master/LICENSE) 。 | ||
| - NSIS，Nullsoft，zlib/libpng 许可证。 | ||
| - WebStorm，JetBrains，[许可证](https://www.jetbrains.com/legal/#licensing)。 | ||
| - WebStorm，JetBrains，[许可证](https://www.jetbrains.com/legal/#licensing) 。 | ||
Oops, something went wrong.