updated README and added a Chinese version

donlinglok1 · Sep 11, 2016 · 624f6c6 · 624f6c6
1 parent 12329de
commit 624f6c6
Show file tree

Hide file tree

Showing 2 changed files with 410 additions and 99 deletions.
diff --git a/README-cn.md b/README-cn.md
@@ -0,0 +1,291 @@
+# QR-Code
+[*back to English*](https://github.com/sylnsfar/qrcode/blob/master/README.md)
+
+* **更新 (160906)**: 新增 **exe** 版本 - [myqr.exe in qrcode_win](https://github.com/sylnsfar/qrcode_win)
+
+* **更新 (160908)**: 新增**网页**版本 - [amazing-qrcode](http://www.amazing-qrcode.com/) *(made by [Maras0830](https://github.com/Maras0830))*
+
+* **更新 (160910)**: 发布到 **PyPI** - [**MyQR**](https://pypi.python.org/pypi/MyQR) ! 
+
+  * 160911: 更新为可导入的模块
+
+  
+
+## 概述
+
+**Python 二维码生成器**
+
+可生成*普通二维码*、*带图片的艺术二维码（黑白与彩色）*、*动态二维码（黑白与彩色）*。
+
+     
+
+            
+
+## Contents 目录
+
+* [概述](#概述)
+* [目录](#目录)
+* [示例](#示例)
+* [安装](#安装)
+* [使用方法](#使用方法)
+  * [命令行方式](#命令行方式)
+  * [作为导入文件](#作为导入文件)
+* [使用提示](#使用提示)
+* [可用字符](#可用字符)
+* [依赖库](#依赖库)
+* [运行环境](#运行环境)
+* [协议](#协议)
+
+
+
+
+## 示例
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/qrs0.jpg)
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/qrs1.jpg)
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/qrs2.jpg)
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/c_qrcode.gif)![](https://github.com/sylnsfar/qrcode/blob/master/example/daftpunktocat-guy_qrcode.gif)
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/zootopia_qrcode.gif)![](https://github.com/sylnsfar/qrcode/blob/master/example/daftpunktocat-guy_qrcode0.gif)
+
+
+
+
+
+## 安装
+
+```python
+# via pip
+pip(3) install myqr(or MyQR)
+```
+
+    
+
+
+
+## 使用方法
+
+### 命令行方式
+
+*（**提示**：如果你尚未安装 [**MyQR**](https://pypi.python.org/pypi/MyQR) ，以下内容请使用`python(3) myqr.py` 而非`myqr` 。）*
+
+```python
+# 概括
+myqr 	Words
+		[-v {1,2,3,...,40}]
+		[-l {L,M,Q,H}]
+        [-n output-filename]
+		[-d output-directory]
+		[-p picture_file]
+		[-c]
+		[-con contrast]
+		[-bri brightness]
+```
+
+- [普通二维码](#普通二维码) 介绍了 `Words`, `-v`, `-l`, `-n`, `-d` 
+- [艺术二维码](#艺术二维码) 介绍了  `-p`, `-c`, `-con`, `-bri`
+- [动态GIF二维码](#动态gif二维码) 介绍了动态的生成方法和注意点
+
+
+
+
+
+#### 普通二维码
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/0.png)
+
+```markdown
+#1 Words
+myqr https://github.com
+```
+
+* 在命令后输入链接或者句子作为参数，然后在程序的当前目录中产生相应的二维码图片文件，默认命名为” qrcode.png“。
+
+  
+
+```markdown
+#2 -v, -l
+myqr https://github.com -v 10 -l Q
+```
+
+* **默认边长**是取决于你输入的信息的长度和使用的纠错等级；
+
+  而**默认纠错等级**是最高级的H。
+
+* **自定义**：如果想要控制边长和纠错水平就使用 `-v` 和 `-l` 参数。
+
+   `-v` 控制边长，范围是**1至40**，数字越大边长越大；
+
+   `-l` 控制纠错水平，范围是**L、M、Q、H**，从左到右依次升高。
+
+
+
+
+```markdown
+#3 -n, -d
+myqr https://github.com -n github_qr.jpg  -d .../paths/
+```
+
+- **默认输出文件名**是“ qrcode.png "，而**默认存储位置**是当前目录。
+
+- 自定义：可以自己定义输出名称和位置。**注意**同名文件会覆盖旧的。
+
+  `-n` 控制文件名，格式可以是 `.jpg`， `.png` ，`.bmp` ，`.gif` ；
+
+  `-d` 控制位置。
+
+  
+
+
+
+
+
+
+#### 艺术二维码
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/1.png)![](https://github.com/sylnsfar/qrcode/blob/master/example/2.png)
+
+
+```markdown
+#1 -p
+myqr https://github.com -p github.jpg
+```
+
+* 参数`-p` 用来将QR二维码图像与一张同目录下的图片相结合，产生一张**黑白**图片。
+
+  
+
+
+
+
+```markdown
+#2 -c
+myqr https://github.com -p github.jpg -c
+```
+
+* 加上参数 `-c` 可以使产生的图片由黑白变为**彩色**的。
+
+  
+
+
+
+```markdown
+#3 -con, -bri
+myqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
+```
+
+* 参数`-con` 用以调节图片的**对比度**，1.0 表示原始图片，更小的值表示更低对比度，更大反之。**默认为1.0**。
+
+* 参数 `-bri` 用来调节图片的**亮度**，其余用法和取值与 `-con` 相同。
+
+
+
+
+#### 动态GIF二维码
+
+![](https://github.com/sylnsfar/qrcode/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/sylnsfar/qrcode/blob/master/example/daftpunktocat-guy_qrcode0.gif)
+
+动态二维码与上述的带图片的二维码的生成方法没什么区别，你只要采用 `.gif` 格式的图片即可生成黑白或者彩色的动态二维码。但**注意**如果使用了 `-n` 参数自定义输出的文件名，切记其格式也必须是 `.gif` 格式。
+
+
+
+### 作为导入文件
+
+```python
+# 安装模块后
+from MyQR import myqr
+version, level, qr_name = myqr.run(
+	words,
+    version=1,
+    level='H',
+    picture=None,
+    colorized=False,
+    contrast=1.0,
+    brightness=1.0,
+    save_name=None,
+    save_dir=os.getcwd()
+	)
+```
+
+
+
+*一下各个参数以及在[上文](#命令行方式)有所介绍*
+
+
+```python
+# help(myqr)
+Positional parameter
+   words: str
+
+Optional parameters
+   version: int, from 1 to 40
+   level: str, just one of ('L','M','Q','H')
+   picutre: str, a filename of a image
+   colorized: bool
+   constrast: float
+   brightness: float
+   save_name: str, the output filename like 'example.png'
+   save_dir: str, the output directory
+```
+
+
+
+
+
+## 使用提示
+
+* 请采用**正方形**或近似正方形的图片
+
+* 建议在图片尺寸大的时候使用 `-v` 的值也应该**适当**变大。
+
+* 如果图片有透明无色部分，最终效果是：![](https://github.com/sylnsfar/qrcode/blob/master/example/aa.png)
+
+  你可以将透明部分修改成白色，最终效果会变成![](https://github.com/sylnsfar/qrcode/blob/master/example/a0.png)
+
+
+
+
+## 可用字符
+
+* 数字 0 到 9
+
+* 大小写的英文字母
+
+* 常用**英文标点符号**和空格
+
+  ```console
+  · , . : ; + - * / \ ~ ! @ # $ % ^ & ` [ ] ( ) ? _ { } | and  (space)
+  ```
+
+
+
+
+## 依赖库
+
+* [pillow](https://pypi.python.org/pypi/Pillow/3.3.1)
+* [numpy](https://pypi.python.org/pypi/numpy)
+* [imageio](https://pypi.python.org/pypi/imageio)
+
+
+
+
+*（**提示**：如果没有安装 [**MyQR**](https://pypi.python.org/pypi/MyQR) ，使用命令`pip install -r requirements.txt` 来安装所有依赖的库。）*
+
+  
+
+## 运行环境
+
+* Linux, Python 3
+* Windows, Python 3
+* Mac, Python 3
+
+
+    
+
+
+## 协议 
+
+* GPLv3