python/amazing-qr
1
0
Fork 0
mirror of https://github.com/x-hw/amazing-qr.git synced 2025-08-10 22:41:23 +02:00
Code Issues Releases Activity

[chg] update readme

Browse Source
This commit is contained in:
hw
2021-05-06 19:03:30 +08:00
parent f1c8116ae6
commit 3837da94ea
4 changed files with 57 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README-cn.md
View File

@@ -1,6 +1,10 @@
# Amazing-QR # Amazing-QR
[*back to English*](https://github.com/hwxhw/amzqr/blob/master/README.md) [![former name](https://img.shields.io/badge/old%20name-MyQR-yellow)](https://pypi.org/project/myqr/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/myqr?label=downloads@myqr)](https://pypi.org/project/myqr/) [![](https://img.shields.io/badge/language-Python-blue)](https://www.python.org/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/amzqr?logo=python&logoColor=ffffff&label=Python&labelColor=blue&color=ffffff) [![PyPI](https://img.shields.io/pypi/v/amzqr?logo=pypi&logoColor=ffffff&label=PyPI&labelColor=blue)](https://pypi.org/project/amzqr/) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/amzqr) [![PyPI - Downloads](https://img.shields.io/pypi/dm/amzqr)](https://pypi.org/project/amzqr/) [![PyPI - License](https://img.shields.io/pypi/l/amzqr)](https://github.com/x-hw/amazing-qr/blob/master/LICENSE.md) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/x-hw/amazing-qr)
[![](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/x-hw/amazing-qr/blob/master/README.md)
## 概述 ## 概述
@@ -23,18 +27,19 @@
* [可用字符](#可用字符) * [可用字符](#可用字符)
* [环境](#环境) * [环境](#环境)
* [协议](#协议) * [协议](#协议)
* [请杯咖啡☕️ / 打赏](#请杯咖啡--打赏)
## 示例 ## 示例
![](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)
## 安装 ## 安装
@@ -68,7 +73,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
@@ -105,9 +110,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
@@ -134,7 +139,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` 格式。
@@ -179,9 +184,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)
## 可用字符 ## 可用字符
@@ -202,3 +207,15 @@ Optional parameters
## 协议 ## 协议
* GPLv3 * GPLv3
## 请杯咖啡 / 打赏
微信:
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/wechatpay.jpg" width = "124" height = "116" alt="wechatpay" align=center />
or
支付宝:
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/alipay_qrcode.png" width = "132" height = "132" alt="alipay" align=center />

39
README.md
View File

@@ -1,6 +1,10 @@
# Amazing-QR # Amazing-QR
[*转到中文版*](https://github.com/hwxhw/amzqr/blob/master/README-cn.md) [![former name](https://img.shields.io/badge/old%20name-MyQR-yellow)](https://pypi.org/project/myqr/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/myqr?label=downloads@myqr)](https://pypi.org/project/myqr/) [![](https://img.shields.io/badge/language-Python-blue)](https://www.python.org/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/amzqr?logo=python&logoColor=ffffff&label=Python&labelColor=blue&color=ffffff) [![PyPI](https://img.shields.io/pypi/v/amzqr?logo=pypi&logoColor=ffffff&label=PyPI&labelColor=blue)](https://pypi.org/project/amzqr/) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/amzqr) [![PyPI - Downloads](https://img.shields.io/pypi/dm/amzqr)](https://pypi.org/project/amzqr/) [![PyPI - License](https://img.shields.io/pypi/l/amzqr)](https://github.com/x-hw/amazing-qr/blob/master/LICENSE.md) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/x-hw/amazing-qr)
[![](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/x-hw/amazing-qr/blob/master/README-cn.md)
## Overview ## Overview
@@ -22,18 +26,19 @@ Generate *common qr-code*, *artistic qr-code (black & white or colorized)*, *a
* [Supported Characters](#supported-characters) * [Supported Characters](#supported-characters)
* [Environment](#environment) * [Environment](#environment)
* [License](#license) * [License](#license)
* [Buy me a coffee ☕️ / Sponsor](#buy-me-a-coffee--sponsor)
## Examples ## Examples
![](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)
## Install ## Install
@@ -67,7 +72,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
@@ -109,7 +114,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
@@ -144,7 +149,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`.
@@ -192,9 +197,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
@@ -215,3 +220,15 @@ Optional parameters
## License ## License
* GPLv3 * GPLv3
## Buy me a coffee / Sponsor
wechat:
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/wechatpay.jpg" width = "124" height = "116" alt="wechatpay" align=center />
or
alipay:
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/alipay_qrcode.png" width = "132" height = "132" alt="alipay" align=center />

BIN
example/alipay_qrcode.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.8 KiB

BIN
example/wechatpay.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 56 KiB