docs update [build skip]
This commit is contained in:
parent
f16807715c
commit
32465d6db5
@ -1,116 +0,0 @@
|
||||
# Difficult Rocket
|
||||
|
||||
[中文](../README.md) | English
|
||||
|
||||
- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
|
||||
- [gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket)
|
||||
- [discord](https://discord.gg/kWzw2JrG6M)
|
||||
- [kook](https://kook.top/sRPjFG)
|
||||
|
||||
<a href="https://996.icu"><img src="https://img.shields.io/badge/link-996.icu-red.svg" alt="996.icu" /></a>
|
||||
[](https://Semver.org/)
|
||||
[](https://Python.org)
|
||||
[](https://pyglet.org)
|
||||
[](https://Python.org)
|
||||
|
||||
## Version
|
||||
|
||||
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
||||
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
||||
[](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/src/plan_features.md)
|
||||
|
||||
- [microsoft TODO](https://to-do.microsoft.com/sharing?InvitationToken=Q6SN1kdtitK8cwFktFl71gSnsRMNmrH7CC7kHY_Tq6ReMRwHgInP4_q5ie2IwrHx8)
|
||||
|
||||
## [Update logs](/docs/src/update_logs.md)
|
||||
|
||||
## Environment (been tested / developed on)
|
||||
|
||||
- `Develop platform 1 - Windows 10 x64 22H2`
|
||||
- `Python 3.8.10`
|
||||
- `pillow 9.3.0`
|
||||
- `pyperclip 1.8.2`
|
||||
- `pyglet 2.0`
|
||||
- `psutil 5.9.4`
|
||||
- `objprint 0.2.2`
|
||||
- `rtoml 0.9.0`
|
||||
- `xmltodict 0.13.0`
|
||||
- `tomlkit 0.11.6`
|
||||
- `AMD R5 5600X`
|
||||
- `AMD RX 550 4G`
|
||||
|
||||
## Required python modules
|
||||
|
||||
- `rtoml`
|
||||
- `tomlkit`
|
||||
- `pyglet` (pre-installed V2.0.4 path:`./libs/pyglet`)
|
||||
- `xmltodict` (pre-installed V0.12.0 path:`./libs/xmltodict`)
|
||||
- `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`)
|
||||
- `pillow`
|
||||
- `defusedxml`
|
||||
- `objprint`
|
||||
- `psutil`
|
||||
|
||||
## thanks to
|
||||
|
||||
- Open Source Projects
|
||||
- [pyglet](https://github.com/pyglet/pyglet): GUI and graphics
|
||||
- `tomlkit` / `rtoml` toml parser
|
||||
- `xmltodict`: translate data between xml and dict
|
||||
- `pyperclip`: paste board!
|
||||
- `rapier2d`: Phy simulate engine
|
||||
|
||||
- Main contributors
|
||||
- [@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.
|
||||
@ -1,110 +0,0 @@
|
||||
# Difficult Rocket
|
||||
|
||||
中文 | [English](/docs/README-en.md)
|
||||
|
||||
- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
|
||||
- [gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket)
|
||||
- [discord](https://discord.gg/kWzw2JrG6M)
|
||||
- [kook](https://kook.top/sRPjFG)
|
||||
|
||||
<a href="https://996.icu"><img src="https://img.shields.io/badge/link-996.icu-red.svg" alt="996.icu" /></a>
|
||||
[](https://Semver.org/)
|
||||
[](https://Python.org)
|
||||
[](https://pyglet.org)
|
||||
[](https://Python.org)
|
||||
|
||||
## 版本
|
||||
|
||||
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
||||
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
||||
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
||||
|
||||
## English README please look [here](./docs/README-en.md)
|
||||
|
||||
> 这是一个用Python制作的类Simple Rocket游戏(简称：火箭模拟器)
|
||||
|
||||
## 优势
|
||||
|
||||
> 相对于原版SR比较“轻量化”
|
||||
|
||||
## [计划特性列表](/docs/plan_features)
|
||||
|
||||
- [microsoft TODO](https://to-do.microsoft.com/sharing?InvitationToken=Q6SN1kdtitK8cwFktFl71gSnsRMNmrH7CC7kHY_Tq6ReMRwHgInP4_q5ie2IwrHx8)
|
||||
|
||||
## [更新日志](/docs/update_logs.md)
|
||||
|
||||
## 环境需求 (测试过的 / 开发平台)
|
||||
|
||||
- `开发平台 1 - Windows 10 x64 22H2`
|
||||
- `Python 3.8.10`
|
||||
- `pillow 9.3.0`
|
||||
- `pyperclip 1.8.2`
|
||||
- `pyglet 2.0`
|
||||
- `psutil 5.9.4`
|
||||
- `objprint 0.2.2`
|
||||
- `rtoml 0.9.0`
|
||||
- `xmltodict 0.13.0`
|
||||
- `tomlkit 0.11.6`
|
||||
- `AMD R5 5600X`
|
||||
- `AMD RX 550 4G`
|
||||
|
||||
## 需要的Python模块
|
||||
|
||||
- `rtoml`
|
||||
- `tomlkit`
|
||||
- `pyglet` (已经内置 V2.0.4 路径：`./libs/pyglet`)
|
||||
- `xmltodict` (已经内置 V0.12.0 路径:`./libs/xmltodict`)
|
||||
- `pyperclip` (已经内置 V1.8.2 路径: `./libs/pyperclip`)
|
||||
- `pillow`
|
||||
- `defusedxml`
|
||||
- `objprint`
|
||||
- `psutil`
|
||||
|
||||
## 感谢
|
||||
|
||||
- 开源项目
|
||||
- [pyglet](https://github.com/pyglet/pyglet) : GUI 和画面渲染
|
||||
- `tomlkit` / `rtoml` : toml 解析器
|
||||
- `xmltodict`: xml 与 dict 转换器
|
||||
- `pyperclip`: 剪贴板!
|
||||
- `rapier2d`: 物理模拟引擎
|
||||
|
||||
- 主要贡献者
|
||||
- [@Rayawa](https://github.com/Rayawa) : 文档矫正 & 翻译部分 lang
|
||||
- [@rouxiao-you](https://github.com/ruoxiao-you) : 翻译 lang
|
||||
- [@Billchyi](https://github.com/Billchyi) : 文档矫正
|
||||
- [@MSDNicrosoft]()
|
||||
|
||||
## 相关链接
|
||||
|
||||
## 关于分享协议
|
||||
|
||||
#### https://creativecommons.org/licenses/by-nc-sa/4.0/
|
||||
|
||||
#### 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)
|
||||
|
||||
这是一份普通人可以理解的许可协议概要 (但不是替代) 。 免责声明.
|
||||
|
||||
您可以自由地：
|
||||
|
||||
共享 — 在任何媒介以任何形式复制、发行本作品
|
||||
|
||||
演绎 — 修改、转换或以本作品为基础进行创作
|
||||
|
||||
只要你遵守许可协议条款，许可人就无法收回你的这些权利。
|
||||
|
||||
惟须遵守下列条件：
|
||||
|
||||
署名 — 您必须给出地当的署名，提供指向本许可协议的链接，同时标明是否（对原始作品）作了修改。您可以用任何合理的方式来署名，但是不得以任何方式暗示许可人为您或您的使用背书。
|
||||
|
||||
非商业性使用 — 您不得将本作品用于商业目的。
|
||||
|
||||
相同方式共享 — 如果您再混合、转换或者基于本作品进行创作，您必须基于与原先许可协议地同的许可协议 分发您贡献的作品。
|
||||
|
||||
没有附加限制 — 您不得适用法律术语或者 技术措施 从而限制其他人做许可协议允许的事情。
|
||||
|
||||
声明：
|
||||
|
||||
您不必因为公共领域的作品要素而遵守许可协议，或者您的使用被可适用的 例外或限制所允许。
|
||||
|
||||
不提供担保。许可协议可能不会给与您意图使用的所必须的所有许可。例如，其他权利比如形象权、隐私权或人格权可能限制您如何使用作品。
|
||||
@ -1,7 +1,7 @@
|
||||
# Summary
|
||||
|
||||
- [README](./README.md)
|
||||
- [README-en](./README-en.md)
|
||||
- [README](../../README.md)
|
||||
- [README-en](../README-en.md)
|
||||
|
||||
- [update logs](./update_logs.md)
|
||||
- [contributors](./contributors.md)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user