Skip to content

Commit

Permalink
docs: Update Explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
aoguai committed Aug 6, 2024
1 parent 8577a95 commit eeadca8
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
23 changes: 21 additions & 2 deletions docs/README-EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ LiYing can run completely offline. All image processing operations are performed

### Bundled Package

If you are a Windows user and do not need to review the code, you can [download the bundled package](https://github.com/aoguai/LiYing/releases/latest) (tested on Windows 7 SP1 & Windows 10). Extract it and drag your images or directory into `run.bat` to start LiYing.
If you are a Windows user and do not need to review the code, you can [download the bundled package](https://github.com/aoguai/LiYing/releases/latest) (tested on Windows 7 SP1 & Windows 10). Extract it and drag your images or directory into `run_en.bat` to start LiYing.

### Setup and Installation

Expand Down Expand Up @@ -140,6 +140,14 @@ The section name represents the values for the `photo-type` and `photo-sheet-siz

Furthermore, `photo-type` and `photo-sheet-size` also support direct input of strings in the format `XXXpx x XXXpx`, representing width and height.

## Changelog

- **2024/08/06 Update**
- Added support for entering width and height in pixels directly for `photo-type` and `photo-sheet-size`, and support for configuration via `data.ini`.
- Fixed issues related to some i18n configurations; now compatible with both English and Chinese settings.
- Fixed other known bugs.


## Acknowledgments

The project was created to help my parents complete their work more easily. I would like to thank my parents for their support.
Expand Down Expand Up @@ -168,4 +176,15 @@ LiYing is an open-source project, and community participation is highly welcomed

## License

[LiYing](https://github.com/aoguai/LiYing) is open-sourced under the AGPL-3.0 license. For details, please refer to the [LICENSE](../LICENSE) file.
[LiYing](https://github.com/aoguai/LiYing) is open-sourced under the AGPL-3.0 license. For details, please refer to the [LICENSE](../LICENSE) file.


## Star History

<a href="https://star-history.com/#aoguai/LiYing&Timeline">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=aoguai/subscription&type=Timeline&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=aoguai/subscription&type=Timeline" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=aoguai/subscription&type=Timeline" />
</picture>
</a>
19 changes: 18 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ LiYing 可以完全离线运行。所有图像处理操作都在本地运行。

### 整合包

如果你是 Windows 用户且没有代码阅览需求,可以[下载整合包](https://github.com/aoguai/LiYing/releases/latest)(已在 Windows 7 SP1 & Windows 10),解压将图片或目录拖入 run.bat 即可启动 LiYing。
如果你是 Windows 用户且没有代码阅览需求,可以[下载整合包](https://github.com/aoguai/LiYing/releases/latest)(已在 Windows 7 SP1 & Windows 10 测试),解压将图片或目录拖入 run_zh.bat 即可启动 LiYing。

### 设置和安装

Expand Down Expand Up @@ -139,6 +139,13 @@ Options:

同时`photo-type``photo-sheet-size`还支持直接输入形如`XXXpx x XXXpx`的字符串,代表宽高。

## 更新日志

- **2024/08/06 更新**
- 新增 photo-type 和 photo-sheet-size 支持直接输入宽高像素,支持使用 data.ini 配置
- 修复 部分 i18n 导致的已知问题,现在可以兼容中英文配置
- 修复 其他已知BUG

## 致谢

该项目的制作初衷和项目名称来源于帮助我的父母更轻松的完成他们的工作,在此感谢我的父母。
Expand Down Expand Up @@ -170,3 +177,13 @@ LiYing 是一个开源项目,非常欢迎社区的参与。要为该项目做
## License 说明

[LiYing](https://github.com/aoguai/LiYing) 使用 AGPL-3.0 license 进行开源,详情请参阅 [LICENSE](../LICENSE) 文件。

## Star History

<a href="https://star-history.com/#aoguai/LiYing&Timeline">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=aoguai/subscription&type=Timeline&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=aoguai/subscription&type=Timeline" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=aoguai/subscription&type=Timeline" />
</picture>
</a>

0 comments on commit eeadca8

Please sign in to comment.