From ddd9d96c8b68eba146893534960bcd3232b55a56 Mon Sep 17 00:00:00 2001 From: SerinaNya <34389622+SerinaNya@users.noreply.github.com> Date: Wed, 10 Apr 2024 21:37:04 +0800 Subject: [PATCH] docs: update README, close https://github.com/SerinaNya/SkinRenderMC/issues/4 --- README.md | 17 +++++++++++++---- README_zh.md | 35 +++++++++++++++++------------------ 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 1bed341..70c3a8d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # SkinRenderMC -[![Docker Image CI](https://github.com/jinzhijie/SkinRenderMC/actions/workflows/docker-images.yml/badge.svg?branch=master)](https://github.com/jinzhijie/SkinRenderMC/actions/workflows/docker-images.yml) +[![Docker Image CI](https://github.com/SerinaNya/SkinRenderMC/actions/workflows/docker-images.yml/badge.svg?branch=master)](https://github.com/SerinaNya/SkinRenderMC/actions/workflows/docker-images.yml) Render your Minecraft Skins and Capes in 3D view. +> [!TIP] +> This project is under development. I will update it soon. + [简体中文版本](./README_zh.md) # What can this app do? @@ -38,6 +41,12 @@ Thanks to `yushijinhun` for guiding me during the development of this app. When the value is `true`, the background of the generated image will be transparent. # Deploy + +> [!IMPORTANT] +> Require **more than** _2 CPU Core & 2GB RAM_ to run this application. +> +> Recommended 4 CPU Core & 4GB RAM. + Check out the **PRETTY** & **HARMLESS** `docker-compose.yml`! You know what you are supposed to do now! @@ -46,11 +55,11 @@ If you don't know what to do, follow the instructions below: ```sh mkdir skinrendermc && cd skinrendermc -curl -O docker-compose.yml https://github.com/jinzhijie/SkinRenderMC/raw/master/docker-compose.yml -sudo docker-compose up -d +curl -O docker-compose.yml https://github.com/SerinaNya/SkinRenderMC/raw/master/docker-compose.yml +sudo docker compose up -d ``` -The server will start on port `57680`. Access `http://:56780/docs` to see API documentation. +The server will start on port `57680`. Access `http://:56780/docs` to see OpenAPI documentation. # Support this Project I know you are busy, but I really need your support! Could you offer me a star? 😭😭😭 diff --git a/README_zh.md b/README_zh.md index f601bab..45db312 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,9 +1,7 @@ # SkinRenderMC 你先别急皮肤渲染器 - -你说的对，但是《SkinRenderMC》是由 Xiao_Jin 开发的一款 Minecraft 皮肤渲染器。软件诞生在一个叫「FastAPI」的美好世界，在这里，被神选中的人将被授予「键盘」，导引「VSCode」​​​‌‌‌‌‌‌‌‌​​‌‌​‌‌‌​‌​。你将扮演一位名为「个人开发者」的神秘角色，在代码的编写中邂逅不同语言、不同框架的同伴们，和他们一起击败「three.js」，找回失散的「WebGL2 Canvas」—— 同时，逐步发掘「Chromium」的真相。 - - +> [!TIP] +> 此项目尚处于开发阶段，我很快就会更新这个项目。 # 此灵车能做什么？ @@ -21,7 +19,7 @@ GET http://:57680/url/image/both ``` -它会吐出来： +它会输出： ![前视角和后视角下的一个名叫 yushijinhun 的 Minecraft 玩家模型](./assets/yushijinhun_both.png) @@ -52,35 +50,36 @@ GET http://:57680/url/image/both # 部署此灵车 +> [!IMPORTANT] +> 需要**至少**_2 CPU 核心 & 2GB 运行内存_ 来运行这个程序！ +> +> 推荐配置为 **4 CPU 核心 & 4GB 运行内存** + +看看那个人畜无害的 `docker-compose.yml` 你就知道了！ + ```sh mkdir skinrendermc && cd skinrendermc -curl -O docker-compose.yml https://github.com/jinzhijie/SkinRenderMC/raw/master/docker-compose.yml -sudo docker-compose up -d +curl -O docker-compose.yml https://github.com/SerinaNya/SkinRenderMC/raw/master/docker-compose.yml +sudo docker compose up -d ``` -服务器将在 `57680` 端口上启动，访问 `http://:56780/docs` 查看 API 文档。 +服务器将在 `57680` 端口上启动，访问 `http://:56780/docs` 查看 OpenAPI 文档。 --- # 中文特供部分 -## 为什么叫这个中文名？ - -> 值越大，越清晰，分辨率越大，数据大小越大。 - -他们无头浏览器是这样的。 - ## 真的很急咋办？ -> 值越大，越清晰，分辨率越大，数据大小越大。 - +速度确实有些慢，这主要是 Headless Chrome 使用 WebGL 渲染导致的，他们无头浏览器是这样的。 -经过测试，`definition=1.5` 能满足大部分场景下的需求。`1.25` 也能将就着用用。 +可以尝试提高运行设备的配置，或参考下述方案调整输出。 ## 糊！ > 值越大，越清晰，分辨率越大，数据大小越大。 +经过测试，`definition=1.5` 能满足大部分场景下的需求。`1.25` 也能将就着用用。 ## 就这么一个功能？ @@ -90,6 +89,6 @@ sudo docker-compose up -d ## 为什么叫灵车？ -因为没有 Star。你知道我要说什么的 → +因为没有 Star。你知道我要说什么的 → 你的 Star 就是我的动力！ \ No newline at end of file