Skip to content

Commit f686bf3

Browse files
committed
docs: create README.md
1 parent fe5697f commit f686bf3

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<div align="center">
2+
<h1 align="center">PearlCalculatorRS</h1>
3+
<p align="center">
4+
一款基于 <a href="https://tauri.app/"><strong>Tauri</strong></a> 和 <a href="https://www.rust-lang.org/"><strong>Rust</strong></a> 开发的高性能 Minecraft 矢量珍珠炮计算器。
5+
<br />
6+
<br />
7+
<a href="https://github.com/MliroLirrorsIngenuity/PearlCalculatorRS/blob/main/README.md">简体中文</a>
8+
|
9+
<a href="https://github.com/MliroLirrorsIngenuity/PearlCalculatorRS/blob/main/README_EN.md">English</a>
10+
</p>
11+
</div>
12+
13+
<details>
14+
<summary>目录</summary>
15+
16+
- [特性](#特性)
17+
- [使用方式](#使用方式)
18+
- [提问前必看](#提问前必看)
19+
- [贡献者](#贡献者)
20+
- [开源协议](#开源协议)
21+
- [致谢](#致谢)
22+
23+
</details>
24+
25+
## 特性
26+
27+
- **高性能计算核心**:利用 Rust 编写的 `pearl_calculator_core` 提供快速、精确的珍珠轨迹与 TNT 爆炸计算。
28+
- **现代化用户界面**:基于 React + TailwindCSS 构建的现代化 UI,提供流畅的交互体验。
29+
- **多功能集成**
30+
- **TNT 计算**:支持多种 TNT 配置与排列方式的计算。
31+
- **模拟器**:内置珍珠轨迹模拟,可快速预测动量及落点。
32+
- **配置向导**:提供直观的配置流程,轻松设置大炮参数。
33+
- **跨平台支持**:得益于 Tauri 框架,支持 Windows、macOS 和 Linux 平台。无需任何依赖。
34+
35+
## 使用方式
36+
37+
前往 [Releases](https://github.com/MliroLirrorsIngenuity/PearlCalculatorRS/releases) 页面下载对应平台的最新版本即可使用。
38+
39+
## 提问前必看
40+
41+
在提问之前,请确保:
42+
43+
- 已经尝试了所有可能的解决方案
44+
- 已经尝试搜索了解决方案(包括但不限于本仓库的 [Issues](https://github.com/MliroLirrorsIngenuity/PearlCalculatorRS/issues)
45+
- 你提供了**足够的信息**帮助开发人员定位问题,包括但不限于下列:
46+
- 软件版本
47+
- 复现步骤
48+
49+
- 提问渠道说明
50+
- **使用问题/配置疑问/其他问题**[Discussions](https://github.com/MliroLirrorsIngenuity/PearlCalculatorRS/discussions)
51+
- **Bug/功能请求**[Issues](https://github.com/MliroLirrorsIngenuity/PearlCalculatorRS/issues)
52+
53+
## 贡献者
54+
<a href="https://github.com/MliroLirrorsIngenuity/PearlCalculatorRS/graphs/contributors">
55+
<img src="https://contrib.rocks/image?repo=MliroLirrorsIngenuity/PearlCalculatorRS&" alt="Contributors" />
56+
</a>
57+
58+
## 开源协议
59+
60+
本项目遵循 [MIT License](LICENSE) 开源协议。
61+
62+
### 协议注意事项
63+
64+
MIT 协议是一个宽松的许可协议,但您在使用本项目的代码时仍需注意以下事项:
65+
66+
1. **保留版权声明**:在您分发本项目的副本或基于本项目衍生的软件中,必须包含原作者的版权声明和许可声明(即 `LICENSE` 文件中的内容)。
67+
2. **免责声明**:本项目按“原样”提供,作者不承担任何因使用本项目而产生的法律责任或担保。
68+
3. **商业使用**:您被允许免费使用、复制、修改、合并、出版发行、散布、再授权及贩售本软件及其副本。
69+
70+
**简而言之,您可以自由地使用和修改代码,但必须保留原作者的署名。**
71+
72+
## 致谢
73+
74+
- [LegendsOfSky/PearlCalculatorCore](https://github.com/LegendsOfSky/PearlCalculatorCore):本项目物理计算核心逻辑移植自该项目
75+
- [Tauri](https://tauri.app/):构建跨平台桌面应用的优秀框架
76+
- [React](https://react.dev/):用于构建用户界面的 JavaScript 库
77+
- [shadcn/ui](https://ui.shadcn.com/):设计精美的 UI 组件库

0 commit comments

Comments
 (0)