python/amazing-qr
1
0
Fork 0
mirror of https://github.com/x-hw/amazing-qr.git synced 2025-07-15 01:24:37 +02:00
Code Issues Releases Activity

Merge pull request #81 from x-hw/readme

Browse Source 
[chg] update readme
This commit is contained in:
x.hw
2021-05-06 19:43:13 +08:00
committed by GitHub
parent 8f4f6ce81d 96dfafe7d3
commit 6f47e33f3a
2 changed files with 27 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README-cn.md
View File

@ -4,8 +4,7 @@
[![](https://img.shields.io/badge/GitHub-x.hw-blue?logo=github)](https://github.com/x-hw) ![GitHub Sponsors](https://img.shields.io/github/sponsors/x-hw?logo=github-sponsors&labelColor=pink&color=white) [![wechatpay](https://img.shields.io/badge/微信打赏--brightgreen?logo=wechat&logoColor=ffffff&labelColor=brightgreen)](#请杯咖啡--打赏) [![alipay](https://img.shields.io/badge/支付宝打赏--blue?logo=alipay&logoColor=ffffff&labelColor=blue)](#请杯咖啡--打赏) [![](https://img.shields.io/badge/GitHub-x.hw-blue?logo=github)](https://github.com/x-hw) ![GitHub Sponsors](https://img.shields.io/github/sponsors/x-hw?logo=github-sponsors&labelColor=pink&color=white) [![wechatpay](https://img.shields.io/badge/微信打赏--brightgreen?logo=wechat&logoColor=ffffff&labelColor=brightgreen)](#请杯咖啡--打赏) [![alipay](https://img.shields.io/badge/支付宝打赏--blue?logo=alipay&logoColor=ffffff&labelColor=blue)](#请杯咖啡--打赏)
[*back to English*](https://github.com/hwxhw/amzqr/blob/master/README.md) [*back to English*](https://github.com/x-hw/amazing-qr/blob/master/README.md)
## 概述 ## 概述
@ -31,15 +30,15 @@
## 示例 ## 示例
![](https://github.com/hwxhw/amazing-qr/blob/master/example/qrs0.jpg) ![](https://github.com/x-hw/amazing-qr/blob/master/example/qrs0.jpg)
![](https://github.com/hwxhw/amazing-qr/blob/master/example/qrs1.jpg) ![](https://github.com/x-hw/amazing-qr/blob/master/example/qrs1.jpg)
![](https://github.com/hwxhw/amazing-qr/blob/master/example/qrs2.jpg) ![](https://github.com/x-hw/amazing-qr/blob/master/example/qrs2.jpg)
![](https://github.com/hwxhw/amazing-qr/blob/master/example/c_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif) ![](https://github.com/x-hw/amazing-qr/blob/master/example/c_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)
![](https://github.com/hwxhw/amazing-qr/blob/master/example/zootopia_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif) ![](https://github.com/x-hw/amazing-qr/blob/master/example/zootopia_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
## 安装 ## 安装
@ -73,7 +72,7 @@ amzqr Words
#### 普通二维码 #### 普通二维码
![](https://github.com/hwxhw/amzqr/blob/master/example/0.png) ![](https://github.com/x-hw/amzqr/blob/master/example/0.png)
```markdown ```markdown
#1 Words #1 Words
@ -110,9 +109,9 @@ amzqr https://github.com -n github_qr.jpg -d .../paths/
`-d` 控制位置。 `-d` 控制位置。
​#### 艺术二维码 #### 艺术二维码
![](https://github.com/hwxhw/amazing-qr/blob/master/example/1.png)![](https://github.com/hwxhw/amazing-qr/blob/master/example/2.png) ![](https://github.com/x-hw/amazing-qr/blob/master/example/1.png)![](https://github.com/x-hw/amazing-qr/blob/master/example/2.png)
```markdown ```markdown
#1 -p #1 -p
@ -139,7 +138,7 @@ amzqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
#### 动态GIF二维码 #### 动态GIF二维码
![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif) ![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
动态二维码与上述的带图片的二维码的生成方法没什么区别，你只要采用 `.gif` 格式的图片即可生成黑白或者彩色的动态二维码。但**注意**如果使用了 `-n` 参数自定义输出的文件名，切记其格式也必须是 `.gif` 格式。 动态二维码与上述的带图片的二维码的生成方法没什么区别，你只要采用 `.gif` 格式的图片即可生成黑白或者彩色的动态二维码。但**注意**如果使用了 `-n` 参数自定义输出的文件名，切记其格式也必须是 `.gif` 格式。
@ -184,9 +183,9 @@ Optional parameters
* 建议在图片尺寸大的时候使用 `-v` 的值也应该**适当**变大。 * 建议在图片尺寸大的时候使用 `-v` 的值也应该**适当**变大。
* 如果图片有透明无色部分，最终效果是：![](https://github.com/hwxhw/amazing-qr/blob/master/example/aa.png) * 如果图片有透明无色部分，最终效果是：![](https://github.com/x-hw/amazing-qr/blob/master/example/aa.png)
你可以将透明部分修改成白色，最终效果会变成![](https://github.com/hwxhw/amazing-qr/blob/master/example/a0.png) 你可以将透明部分修改成白色，最终效果会变成![](https://github.com/x-hw/amazing-qr/blob/master/example/a0.png)
## 可用字符 ## 可用字符
@ -211,9 +210,11 @@ Optional parameters
## 请杯咖啡 / 打赏 ## 请杯咖啡 / 打赏
微信: 微信:
![wechatpay](https://github.com/hwxhw/amazing-qr/blob/master/example/wechatpay.jpg)
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/wechatpay.jpg" width = "124" height = "116" alt="wechatpay" align=center />
or or
支付宝: 支付宝:
![alipay](https://github.com/hwxhw/amazing-qr/blob/master/example/alipay-qrcode.png)
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/alipay_qrcode.png" width = "132" height = "132" alt="alipay" align=center />

19
README.md
View File

@ -4,7 +4,8 @@
[![](https://img.shields.io/badge/GitHub-x.hw-blue?logo=github)](https://github.com/x-hw) ![GitHub Sponsors](https://img.shields.io/github/sponsors/x-hw?logo=github-sponsors&labelColor=pink&color=white) [![wechatpay](https://img.shields.io/badge/sponsor_by_wechat--brightgreen?logo=wechat&logoColor=ffffff&labelColor=brightgreen)](#buy-me-a-coffee--sponsor) [![alipay](https://img.shields.io/badge/sponsor_by_alipay--blue?logo=alipay&logoColor=ffffff&labelColor=blue)](#buy-me-a-coffee--sponsor) [![](https://img.shields.io/badge/GitHub-x.hw-blue?logo=github)](https://github.com/x-hw) ![GitHub Sponsors](https://img.shields.io/github/sponsors/x-hw?logo=github-sponsors&labelColor=pink&color=white) [![wechatpay](https://img.shields.io/badge/sponsor_by_wechat--brightgreen?logo=wechat&logoColor=ffffff&labelColor=brightgreen)](#buy-me-a-coffee--sponsor) [![alipay](https://img.shields.io/badge/sponsor_by_alipay--blue?logo=alipay&logoColor=ffffff&labelColor=blue)](#buy-me-a-coffee--sponsor)
[*转到中文版*](https://github.com/hwxhw/amzqr/blob/master/README-cn.md)
[*转到中文版*](https://github.com/x-hw/amazing-qr/blob/master/README-cn.md)
## Overview ## Overview
@ -72,7 +73,7 @@ amzqr Words
#### Common QR-Code #### Common QR-Code
![](https://github.com/hwxhw/amazing-qr/blob/master/example/0.png) ![](https://github.com/x-hw/amazing-qr/blob/master/example/0.png)
```markdown ```markdown
#1 Words #1 Words
@ -114,7 +115,7 @@ amzqr https://github.com -n github_qr.jpg -d .../paths/
#### Artistic QR-Code #### Artistic QR-Code
![](https://github.com/hwxhw/amazing-qr/blob/master/example/1.png)![](https://github.com/hwxhw/amazing-qr/blob/master/example/2.png) ![](https://github.com/x-hw/amazing-qr/blob/master/example/1.png)![](https://github.com/x-hw/amazing-qr/blob/master/example/2.png)
```markdown ```markdown
@ -149,7 +150,7 @@ amzqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
#### Animated GIF QR-Code #### Animated GIF QR-Code
![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif) ![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
The only difference from Artistic QR-Code mentioned above is that you should input an image file in the `.gif` format. The you can get your black-and-white or colorful qr-code. Remember that when you use `-n` to customize the output-filename, then the output-filename must end by `.gif`. The only difference from Artistic QR-Code mentioned above is that you should input an image file in the `.gif` format. The you can get your black-and-white or colorful qr-code. Remember that when you use `-n` to customize the output-filename, then the output-filename must end by `.gif`.
@ -197,9 +198,9 @@ Optional parameters
* If the size of the picture is large, you should also choose a **rightly** large `-v` instead of using the default one. * If the size of the picture is large, you should also choose a **rightly** large `-v` instead of using the default one.
* If part of the picture is transparent, the qr code will look like: ![](https://github.com/hwxhw/amazing-qr/blob/master/example/aa.png) * If part of the picture is transparent, the qr code will look like: ![](https://github.com/x-hw/amazing-qr/blob/master/example/aa.png)
You can change the transparent layer to white, and then it will look like: ![](https://github.com/hwxhw/amazing-qr/blob/master/example/a0.png) You can change the transparent layer to white, and then it will look like: ![](https://github.com/x-hw/amazing-qr/blob/master/example/a0.png)
## Supported Characters ## Supported Characters
@ -224,9 +225,11 @@ Optional parameters
## Buy me a coffee / Sponsor ## Buy me a coffee / Sponsor
wechat: wechat:
![wechatpay](https://github.com/hwxhw/amazing-qr/blob/master/example/wechatpay.jpg)
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/wechatpay.jpg" width = "124" height = "116" alt="wechatpay" align=center />
or or
alipay: alipay:
![alipay](https://github.com/hwxhw/amazing-qr/blob/master/example/alipay-qrcode.png)
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/alipay_qrcode.png" width = "132" height = "132" alt="alipay" align=center />