From a93fce9feb0e9e746b547acb82b830d8eeb4825d Mon Sep 17 00:00:00 2001 From: Discreater Date: Thu, 24 Jun 2021 14:22:52 +0800 Subject: [PATCH] doc: update README --- README.md | 20 +++++++++++--------- README_CN.md | 22 ++++++++++++---------- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 9c508e6..5ad8b44 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ order to help you calculate the amount of resources to craft a specific amount o This might be a little confusing, here's an example: - you want to know how many wood logs do you need to craft 40 stairs, simply load the recipe you want to use, and it will -tell you 13 logs should be enough, that's all. + tell you 13 logs should be enough, that's all. This mod is focused on calculation, so you might find it powerful and high performance in some complicated cases. Have fun! @@ -23,7 +23,7 @@ the [release page](https://minecraft.curseforge.com/projects/just-enough-calcula - Support get catalyst in [NEI-GTNH-2.1](https://github.com/GTNewHorizons/NotEnoughItems) - Infinite inputs, outputs and catalysts of recipe - Math calculation -- Recipe can transferred from NEI recipe handler (recipe gui) +- Recipe can be transferred from NEI recipe overlay gui (`shift` + click `?` button) - [x] vanilla - [x] gregtech - [x] Forestry @@ -37,22 +37,24 @@ the [release page](https://minecraft.curseforge.com/projects/just-enough-calcula ## Usage +Tutorial links: +- [mcmod.cn](https://www.mcmod.cn/post/1650.html) [Chinese] by @全麦 +- general usage: #85 + ### **Setup keybinding** - ![setup keybinding](docs/setup_keybinding.png) +![setup keybinding](docs/setup_keybinding.png) ### Main page - ![main page](docs/main_page.png) - -### General usage -see [here](https://github.com/Towdium/JustEnoughCalculation/issues/85) +![main page](docs/main_page.png) + ## TODO -- add new button to transfer the recipe. +- add new button to transfer the recipe. ## Known Issues -- [ ] **May crash** if you open the gui immediately after entering the world +- [ ] **May crash** if you open the gui immediately after entering the world. Please wait for the NEI to load completely. - [ ] Fluid from NEI ItemPanel will be recognized as item - [ ] Some OreDict items renders wrong with overlay (Now removed the overlay) - [ ] GUI will cover the NEI's GUI like tooltip on item panel diff --git a/README_CN.md b/README_CN.md index 6c9561a..ac5cc70 100644 --- a/README_CN.md +++ b/README_CN.md @@ -8,7 +8,7 @@ order to help you calculate the amount of resources to craft a specific amount o This might be a little confusing, here's an example: - you want to know how many wood logs do you need to craft 40 stairs, simply load the recipe you want to use, and it will -tell you 13 logs should be enough, that's all. + tell you 13 logs should be enough, that's all. This mod is focused on calculation, so you might find it powerful and high performance in some complicated cases. Have fun! @@ -22,7 +22,7 @@ This mod is focused on calculation, so you might find it powerful and high perfo - 支持 [NEI-GTNH-2.1](https://github.com/GTNewHorizons/NotEnoughItems) 的催化剂(不消耗的合成参与者,如工作台,各种机器之类的) - 合成表的输入、输出和催化剂 无数量限制 - 数学计算器 -- 可以从 NEI 合成表 gui 页面直接获取合成表 +- 可以从 NEI 合成表 gui 页面直接获取合成表 (`shift` + 单击 `?` 按钮) - [x] 原生MC - [x] gregtech - [x] Forestry @@ -35,14 +35,16 @@ This mod is focused on calculation, so you might find it powerful and high perfo ## 使用方法 +教程链接: +- [mcmod.cn](https://www.mcmod.cn/post/1650.html) by @全麦 +- [一般用法](https://github.com/Towdium/JustEnoughCalculation/issues/85) + + ### **设置按键绑定** - ![setup keybinding](docs/setup_keybinding.png) +![setup keybinding](docs/setup_keybinding.png) -### 主页面 - ![main page](docs/main_page.png) - -### 一般用法 -看 [这儿](https://github.com/Towdium/JustEnoughCalculation/issues/85) +### 主页面 +![main page](docs/main_page.png) ## TODO @@ -51,11 +53,11 @@ This mod is focused on calculation, so you might find it powerful and high perfo ## 已知问题 -- [ ] 如果在进入是世界后立刻打开计算器 gui,游戏可能会 **崩溃 (强烈建议进入世界后等 3~4 秒)** +- [ ] 如果在进入世界后立刻打开计算器 gui,游戏可能会 **崩溃**,请等待NEI完全加载完成 - [ ] 从 NEI 物品列表抓取的 流体 会被识别为 物体 - [ ] 由于矿物词典标签的渲染存在问题,目前暂时不显示覆盖的标识 - [ ] 计算器 gui 会覆盖 NEI 的 tooltip -- [ ] 流体需要针对 mod 进行适配, 开发人员可以查看 [Adapter](./src/main/java/me/towdium/jecalculation/nei/Adapter.java). +- [ ] 流体需要针对 mod 进行适配, 开发人员可以查看 [Adapter](./src/main/java/me/towdium/jecalculation/nei/Adapter.java) ## 开发