Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
aoguai committed Aug 3, 2024
1 parent 81f778c commit 045b044
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/README-EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,23 @@ Options:
--help Show this message and exit.
```

#### Other Configuration

In this version, the standard ID photo configuration is set in `data/data.ini`, which you can use with the `photo-type` parameter.

You can also modify this configuration file to customize ID photo types. The format is as follows:
```text
[XXX]
打印尺寸 = XXXcm x XXXcm
电子版尺寸 = XXXpx x XXXpx
分辨率 = XXXdpi
```
The section name and `电子版尺寸 = XXXpx x XXXpx` are required.

The section name represents the `photo-type` parameter.

Currently, the `key` for size only supports the fixed Chinese `电子版尺寸` (Digital Size). This will be improved in future versions.

## 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
17 changes: 17 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,23 @@ Options:

```

#### 其他配置

在该版本中,在`data/data.ini`中设置了常规的证件照配置,您可以在`photo-type`参数中使用。

同时你可以修改该配置文件,自定义证件照类型。其格式为
```text
[XXX]
打印尺寸 = XXXcm x XXXcm
电子版尺寸 = XXXpx x XXXpx
分辨率 = XXXdpi
```
其中节名称及`[XXX]``电子版尺寸 = XXXpx x XXXpx`是必须的。

其中节名称代表了其`photo-type`参数。

目前,针对尺寸大小的 `key` 只支持固定中文 `电子版尺寸`,将在以后版本改进。

## 致谢

该项目的制作初衷和项目名称来源于帮助我的父母更轻松的完成他们的工作,在此感谢我的父母。
Expand Down

0 comments on commit 045b044

Please sign in to comment.