diff --git a/README.md b/README.md index b36f40e..35aeb6e 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,51 @@ # Difficult Rocket -[中文](./docs/README-cn.md) | English +[comment]: <> ([中文](./docs/README-cn.md) | English) -[comment]: <> (中文 | [English](https://github.com/shenjackyuanjie/Difficult-Rocket).) +中文 | [English](./docs/README-en.md) - [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket) - [gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket) [![Generic badge](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](https://Semver.org/) -[![Generic badge](https://img.shields.io/badge/Write_with_Python-3.8.10-blue.svg)](https://Python.org) -[![Generic badge](https://img.shields.io/badge/Write_with_Pyglet-2.0dev13-blue.svg)](https://pyglet.org) +[![Generic badge](https://img.shields.io/badge/编写于_Python_版本-3.8.10-blue.svg)](https://Python.org) +[![Generic badge](https://img.shields.io/badge/编写于_Pyglet_版本-2.0dev11-blue.svg)](https://pyglet.org) [![Generic badge](https://img.shields.io/badge/Python-_3.8_|_3.9_|_3.10_-blue.svg)](https://Python.org) -## Version +## 版本 [![Generic badge](https://img.shields.io/badge/Release-0.6.1-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) -
[![Generic badge](https://img.shields.io/badge/Pre_Release-0.6.1-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) -
![Generic badge](https://img.shields.io/badge/Devloping-0.6.2-blue.svg) +[![Generic badge](https://img.shields.io/badge/Pre_Release-0.6.1-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) +[![Generic badge](https://img.shields.io/badge/Devloping-0.6.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) -## 中文README请移步 [这里](/docs/README-cn.md) +## English README please look [here](../README.md) -> Difficult-rocket is a Simple Rocket liked game build with Python (in short: rocket simulator) +> 这是一个用Python制作的类Simple Rocket游戏(简称：火箭模拟器) -## Advantage +## 优势 -> Lighter than Vanilla SR +> 相对于原版SR比较“轻量化” -## [Plan feature list](/docs/plan_features) +## [计划特性列表](./plan_features) - [microsoft TODO](https://to-do.microsoft.com/sharing?InvitationToken=Q6SN1kdtitK8cwFktFl71gSnsRMNmrH7CC7kHY_Tq6ReMRwHgInP4_q5ie2IwrHx8) -## [Update logs](/docs/update_logs.md) +## [更新日志](./update_logs.md) -## Environment (been tested / develop on) +## 环境需求 (测试过的 / 开发平台) -- `Develop platform 1 - Windows 10` +- `开发平台 1 - Windows 10` - `Python 3.8.10` - `Windows10 x64` - `json5 0.9.6` - `pillow 8.1.0` - `pyperclip 1.8.2` - - `pyglet 2.0.dev13` + - `pyglet 2.0.dev11` - `xmltodict 0.12.0` - `toml 0.10.2` - `AMD R5 5600X` - `AMD RX 550 4G` -- `Develop platform 2 - macOS Big Sur` +- `开发平台 2 - macOS Big Sur` - `Python 3.8.7` - `macOS Big Sur 11.2.1` - `Pyglet 1.5.15` @@ -53,64 +53,57 @@ - `pillow 8.1.2` - `Intel I5 8279U` -## Required python modules +## 需要的Python模块 -- `json5` (pre-installed V0.9.6 path:`./libs/json5`) -- `toml` (pre-installed V0.10.2 path:`./libs/toml`) -- `pyglet` (pre-installed V2.0.dev11 path:`./libs/pyglet`) -- `xmltodict` (pre-installed V0.12.0 path:`./libs/xmltodict`) -- `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`) +- `json5` (已经内置 V0.9.6 路径：`./libs/json5`) +- `toml` (已经内置 V0.10.2 路径：`./libs/toml`) +- `pyglet` (已经内置 V2.0.dev18 路径：`./libs/pyglet`) +- `xmltodict` (已经内置 V0.12.0 路径:`./libs/xmltodict`) +- `pyperclip` (已经内置 V1.8.2 路径: `./libs/pyperclip`) - `pillow` - `semver` -## thanks to +## 感谢 -- [pyglet](https://github.com/pyglet/pyglet): GUI -- `json5`: json5 parser -- `toml` toml parser -- `xmltodict`: translate data between xml and dict -- `pyperclip`: paste board! -- [@Rayawa](https://github.com/Rayawa) : check mistake in docs & some translates -- [@rouxiao-you](https://github.com/ruoxiao-you) : translate chinese to English -- [@Billchyi](https://github.com/Billchyi) : check mistake in docs +- [pyglet](https://github.com/pyglet/pyglet) : 图形界面 +- `json5`: json5解析器 +- `toml`: toml解析器 +- `xmltodict`: xml 与 dict 转换器 +- `pyperclip`: 剪贴板! +- [@Rayawa](https://github.com/Rayawa) : 文档矫正&翻译部分lang +- [@rouxiao-you](https://github.com/ruoxiao-you) : 翻译lang +- [@Billchyi](https://github.com/Billchyi) : 文档矫正 -## Other links +## 相关链接 -## About License +## 关于分享协议 #### https://creativecommons.org/licenses/by-nc-sa/4.0/ -#### Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) +#### 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) -This is a human-readable summary of (and not a substitute for) the license. Disclaimer. +这是一份普通人可以理解的许可协议概要 (但不是替代) 。 免责声明. -You are free to: +您可以自由地： -Share — copy and redistribute the material in any medium or format +共享 — 在任何媒介以任何形式复制、发行本作品 -Adapt — remix, transform, and build upon the material +演绎 — 修改、转换或以本作品为基础进行创作 -The licensor cannot revoke these freedoms as long as you follow the license terms. +只要你遵守许可协议条款，许可人就无法收回你的这些权利。 -Under the following terms: +惟须遵守下列条件： -Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You -may do so in any reasonable manner, but not in any way +署名 — 您必须给出地当的署名，提供指向本许可协议的链接，同时标明是否（对原始作品）作了修改。您可以用任何合理的方式来署名，但是不得以任何方式暗示许可人为您或您的使用背书。 -that suggests the licensor endorses you or your use. +非商业性使用 — 您不得将本作品用于商业目的。 -NonCommercial — You may not use the material for commercial purposes. +相同方式共享 — 如果您再混合、转换或者基于本作品进行创作，您必须基于与原先许可协议地同的许可协议 分发您贡献的作品。 -ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same -license as the original. +没有附加限制 — 您不得适用法律术语或者 技术措施 从而限制其他人做许可协议允许的事情。 -No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from -doing anything the license permits. +声明： -Notices: +您不必因为公共领域的作品要素而遵守许可协议，或者您的使用被可适用的 例外或限制所允许。 -You do not have to comply with the license for elements of the material in the public domain or where your use is -permitted by an applicable exception or limitation. - -No warranties are given. The license may not give you all the permissions necessary for your intended use. For example, -other rights such as publicity, privacy, or moral rights may limit how you use the material. +不提供担保。许可协议可能不会给与您意图使用的所必须的所有许可。例如，其他权利比如形象权、隐私权或人格权可能限制您如何使用作品。 diff --git a/docs/README-en.md b/docs/README-en.md new file mode 100644 index 0000000..eecaad4 --- /dev/null +++ b/docs/README-en.md @@ -0,0 +1,116 @@ + # Difficult Rocket + +[中文](../README.md) | English + +[comment]: <> (中文 | [English](https://github.com/shenjackyuanjie/Difficult-Rocket).) + +- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket) +- [gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket) + +[![Generic badge](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](https://Semver.org/) +[![Generic badge](https://img.shields.io/badge/Write_with_Python-3.8.10-blue.svg)](https://Python.org) +[![Generic badge](https://img.shields.io/badge/Write_with_Pyglet-2.0dev13-blue.svg)](https://pyglet.org) +[![Generic badge](https://img.shields.io/badge/Python-_3.8_|_3.9_|_3.10_-blue.svg)](https://Python.org) + +## Version + +[![Generic badge](https://img.shields.io/badge/Release-0.6.1-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) +[![Generic badge](https://img.shields.io/badge/Pre_Release-0.6.1-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) +[![Generic badge](https://img.shields.io/badge/Devloping-0.6.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) + +## 中文README请移步 [这里](../README.md) + +> Difficult-rocket is a Simple Rocket liked game build with Python (in short: rocket simulator) + +## Advantage + +> Lighter than Vanilla SR + +## [Plan feature list](/docs/plan_features) + +- [microsoft TODO](https://to-do.microsoft.com/sharing?InvitationToken=Q6SN1kdtitK8cwFktFl71gSnsRMNmrH7CC7kHY_Tq6ReMRwHgInP4_q5ie2IwrHx8) + +## [Update logs](/docs/update_logs.md) + +## Environment (been tested / develop on) + +- `Develop platform 1 - Windows 10` + - `Python 3.8.10` + - `Windows10 x64` + - `json5 0.9.6` + - `pillow 8.1.0` + - `pyperclip 1.8.2` + - `pyglet 2.0.dev13` + - `xmltodict 0.12.0` + - `toml 0.10.2` + - `AMD R5 5600X` + - `AMD RX 550 4G` +- `Develop platform 2 - macOS Big Sur` + - `Python 3.8.7` + - `macOS Big Sur 11.2.1` + - `Pyglet 1.5.15` + - `Json5 0.9.5` + - `pillow 8.1.2` + - `Intel I5 8279U` + +## Required python modules + +- `json5` (pre-installed V0.9.6 path:`./libs/json5`) +- `toml` (pre-installed V0.10.2 path:`./libs/toml`) +- `pyglet` (pre-installed V2.0.dev18 path:`./libs/pyglet`) +- `xmltodict` (pre-installed V0.12.0 path:`./libs/xmltodict`) +- `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`) +- `pillow` +- `semver` + +## thanks to + +- [pyglet](https://github.com/pyglet/pyglet): GUI +- `json5`: json5 parser +- `toml` toml parser +- `xmltodict`: translate data between xml and dict +- `pyperclip`: paste board! +- [@Rayawa](https://github.com/Rayawa) : check mistake in docs & some translates +- [@rouxiao-you](https://github.com/ruoxiao-you) : translate chinese to English +- [@Billchyi](https://github.com/Billchyi) : check mistake in docs + +## Other links + +## About License + +#### https://creativecommons.org/licenses/by-nc-sa/4.0/ + +#### Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) + +This is a human-readable summary of (and not a substitute for) the license. Disclaimer. + +You are free to: + +Share — copy and redistribute the material in any medium or format + +Adapt — remix, transform, and build upon the material + +The licensor cannot revoke these freedoms as long as you follow the license terms. + +Under the following terms: + +Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You +may do so in any reasonable manner, but not in any way + +that suggests the licensor endorses you or your use. + +NonCommercial — You may not use the material for commercial purposes. + +ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same +license as the original. + +No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from +doing anything the license permits. + +Notices: + +You do not have to comply with the license for elements of the material in the public domain or where your use is +permitted by an applicable exception or limitation. + +No warranties are given. The license may not give you all the permissions necessary for your intended use. For example, +other rights such as publicity, privacy, or moral rights may limit how you use the material.