Updated README.md.

10 years ago · b2708b75fc
parent 9801b67f61
commit b2708b75fc
1 changed files with 76 additions and 47 deletions
--- a/README.md
+++ b/README.md
@ -42,7 +42,7 @@ EasyPR是一个中文的开源车牌识别系统，其目标是成为一个简

 ### 兼容性

-EasyPR是基于opencv2.4.8版本开发的，2.4.8以上的版本应该可以兼容，以前的版本可能会存在不兼容的现象。opencv3.0的版本还没有经过测试。
+当前EasyPR是基于opencv3.0版本开发的，3.0及以上的版本应该可以兼容，以前的版本可能会存在不兼容的现象。

 ### 例子

@ -129,95 +129,126 @@ EasyPR的所有源代码可在Github上的[项目主页](https://github.com/liur

 如果你熟悉git版本控制工具，可以使用下面的命令来从Github里克隆代码：

-```
-$ git clone https://github.com/liuruoze/EasyPR
-```
+    $ git clone https://github.com/liuruoze/EasyPR

 EasyPR支持当前主流的操作系统，通常不需要对源代码进行更改就可以编译运行，尽管如此，不同平台上IDE的配置也是有很大差异的，下面主要说明Windows，Linux以及Mac OS下的编译方法。

-**Note**: 无论在哪个平台使用EasyPR，都要安装对应平台版本的[opencv](http://opencv.org/)，建议使用正式稳定版本。
-
-windows平台下的opencv的配置可以参考这份[博客](http://my.phirobot.com/blog/2014-02-opencv_configuration_in_vs.html)。
+**Note**: 无论在哪个平台使用EasyPR，首先都要安装对应平台版本的[opencv](http://opencv.org/)，建议使用正式稳定版本。

 #### Windows

-Windows下的配置建议使用最新的Visual Studio 2013版本。
+Windows下的配置建议使用最新的**Visual Studio 2013**版本。目前opencv3.0已经不支持vs2010，vs2012对C++ 11支持的不足，会存在编译问题。
+
+在之前版本的使用和交流过程中，我们发现很多同学对Visual Studio开发环境不甚了解，甚至没有做过C++项目，对EasyPR环境的配置存在很大的障碍。为此在新版本中我们特意准备了傻瓜式自动配置脚本，来方便大家使用EasyPR。

-目前2010与2012下会存在编译问题，这是由于老版本对C++ 11特性支持的不足导致的。
+**方法一（推荐）**

-* 打开项目目录下的解决方案文件`EasyPR.sln`。
+1. 首先你需要安装最新版本的[Python](https://www.python.org/downloads/)。将Python的安装目录（默认安装在C:\Python34）添加到系统环境变量PATH中。
+2. 双击 `configure.py` 运行脚本，根据提示填写相关信息。
+3. 打开解决方案文件 `EasyPR.sln`，直接编译运行即可。
+
+**方法二**
+
+* 打开解决方案文件 `EasyPR.sln`。

 **Note**: 该解决方案会加载两个项目，一个是`EasyPR`，用于编译src/下的源文件生成静态库`libeasypr.lib`；另一个是`Demo`，用来编译test/下的main.cpp，并链接libeasypr.lib生成可执行程序。

-* 配置OpenCV库
+* 配置OpenCV

 OpenCV for Windows通常会将使用VS编译好二进制文件放到`opencv\build\`目录下。

-EasyPR两个项目的Debug和Release模式都会引用opencv.props属性表，用属性表管理器打开，修改用户宏里面的`OpenCV`项，使之指向你的OpenCV的build目录。
+解决方案自动加载的两个项目配置不符合你的环境，请依次手动配置：
+
+**demo**
+`C/C++`-`附加包含目录`：**[opencv3的include目录]**;$(SolutionDir)include
+`链接器`-`附加库目录`：**[opencv3的lib目录]**
+`链接器`-`输入`-`附加依赖项`：**opencv_world300d.lib**;%(AdditionalDependencies)

-**Note**: 如果你使用的opencv版本不是`2.4.11`，请修改属性表下的`链接器`-`输入`-`附加依赖项`，调整为对应版本的lib。
+*Note*：Debug版本为**opencv_world300d.lib**，Release版本为**opencv_world300.lib**
+
+**libeasypr**
+`C/C++`-`附加包含目录`：**[opencv3的include目录]**;$(SolutionDir)include

-**Note**: 如果你要使用X64的opencv库或者其他版本的VS，请修改`链接器`-`常规`-`附加库目录`，调整为对应的版本。

 * 生成解决方案

-默认情况下，生成出现的`libeasypr.lib`和`easypr_test.exe`会放在`bin\debug(release)`下。
+默认情况下，生成的 `demo.exe` 会放在项目根目录下。
+
+**Note**: 直接双击运行程序会出现找不到opencv动态库的情况，这个时候有两个办法：
+
+* 在`opencv3\build\x86(x64)\vc(..)\bin`下找到缺失的dll放到执行目录下。
+* 将上述bin目录添加到系统环境变量**PATH**中，然后重新运行程序。

-**Note**: 直接双击运行程序会出现找不到opencv动态库的情况，这个时候只需要在`opencv\build\x86(x64)\vc(..)\bin`下找到缺失的dll放到执行目录即可。
+**参考**：windows平台下的opencv的手动配置可以参考这份[博客](http://my.phirobot.com/blog/2014-02-opencv_configuration_in_vs.html)。

 #### Linux & Mac OS

-EasyPR使用CMake在Linux及Mac OS下进行构建，确保系统安装了最新版本的[CMake](http://cmake.org)，然后在任意目录(将存放编译所需的Makefile)执行：
+EasyPR使用CMake在Linux及Mac OS下进行构建，确保系统安装了最新版本的[CMake](http://cmake.org)。

-```
-$ cmake path/to/EasyPR
-```
+为了避免系统中安装的老版本opencv对编译的影响，需要在 `CMakeLists.txt` 中修改：
+
+    set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} "/usr/local/opt/opencv3")

-完成后在同一目录下执行编译命令：
+路径指向opencv3的安装目录，该目录下应该有OpenCV的CMake配置文件。
+
+项目提供了一键编译shell，在项目根目录下执行：

 ```
-$ make
+$ ./build
 ```

-CMake将首先把EasyPR/src下的源文件编译打包为静态库`libeasypr.a`，然后编译`test/main.cpp`，链接静态库生成可执行程序`easypr_test`。
+即可。

 -----

-**Note**: *你可以直接利用EasyPR/include和这个静态库来调用EasyPR提供的函数接口编写自己的程序。*
+**Note**: *你可以直接利用 EasyPR/include 和编译生成的静态库来调用EasyPR提供的函数接口编写自己的程序。*

 运行Demo：

 ```
-$ ./easypr_test // 进入菜单交互界面
-$ ./easypr_test ? // 查看CLI帮助
+$ ./demo // 进入菜单交互界面
+$ ./demo ? // 查看CLI帮助
 ```

 ### 命令行示例

-可以向`easypr_test[.exe]`传递命令行参数来完成你想要的工作，目前Demo支持四个子命令，其他功能如字符识别将逐步加入。对于每个子命令的帮助信息可以传入`-h`参数来获取。
+可以向 `demo[.exe]` 传递命令行参数来完成你想要的工作，目前Demo支持5个子命令。对于每个子命令的帮助信息可以传入 `-h` 参数来获取。

 **车牌识别**

-```
-# 利用提供的SVM和ANN模型来识别一张图片里面的所有车牌
-$ ./easypr_test recognize -p resources/image/plate_recognize.jpg --svm resources/model/svm.xml --ann resources/model/ann.xml
-# 或者更简单一些(注意模型路径)
-$ ./easypr_test recognize -p resources/image/plate_recognize.jpg
-```
+    # 利用提供的SVM和ANN模型来识别一张图片里面的所有车牌
+    
+    $ ./demo recognize -p resources/image/plate_recognize.jpg --svm resources/model/svm.xml --ann resources/model/ann.xml
+    
+    # 或者更简单一些(注意模型路径)
+    $ ./demo recognize -p resources/image/plate_recognize.jpg

 **SVM训练**

-```
-# 首先生成训练用图片
-$ ./easypr_test svm --create --in raw/ --out learn/
-# 接下来给训练用图片打标签，自动把“是”车牌的图块放到has/，“不是”车牌的图块放到no/里，注意这里要使用svm.xml的原因是为了简化你的分类工作量，你也可以手动对图块分类
-$ ./easypr_test svm --tag --source=learn/ --has=has/ --no=no/ --svm=resources/model/svm.xml
-# 接下来就是训练过程了，--divide意味着训练程序会对两个目录下的图块进行划分，默认是70%的训练数据，30%的测试数据，分别放在
-# has/train(70%), has/test; 
-# no/train(70%), no/test
-# Note: 目前你需要自己建立子目录
-$ ./easypr_test svm --train --has-plate=has/ --no-plate=no/ --divide --svm=save/to/svm.xml
-```
+新版本的EasyPR大大简化了SVM训练：
+
+    # 首先准备好车牌图片集合plates/
+    #    是车牌的放在plates/has/
+    #    不是车牌的放在plates/no/
+    #    车牌可从项目resources/train/svm.7z中解压得到。
+    
+    $ ./demo svm --plates=path/to/your/plates --svm=save/to/svm.xml
+    
+    # 该命令将70%的车牌作为训练数据，另外30%的车牌作为测试数据，
+    # 这个只可在 include/easypr/config.h 修改。
+    # 将训练好的模型存放在 save/to/svm.xml。
+
+**ANN训练**
+
+先准备好字符图片集合，可从项目resources/train/ann.7z中解压得到。
+
+每类字符都存放在以其名称命名的子文件夹中，命名规则请参考 `include/easypr/config.h`。
+
+一切准备就绪后，运行下面这条命令即可：
+
+    $ ./demo ann --chars=path/to/chars --ann=save/to/ann.xml
+
+### 获取帮助

 详细的开发与教程请见[介绍与开发教程](http://www.cnblogs.com/subconscious/p/3979988.html)。

@ -243,6 +274,4 @@ $ ./easypr_test svm --train --has-plate=has/ --no-plate=no/ --divide --svm=save/

 taotao1233，邱锦山，唐大侠，jsxyhelu，如果有一天(zhoushiwei)，学习奋斗，袁承志，

-圣城小石匠，goldriver，Micooz，梦里时光，Rain Wang，任薛纪，ahccom，星夜落尘，海豚嘎嘎(车主之家)，
-
-刘超，Free&&Easy, 以及所有对EasyPR贡献数据的热心同学。
+圣城小石匠，goldriver，Micooz，梦里时光，Rain Wang，任薛纪，ahccom，星夜落尘，海豚嘎嘎(车主之家)，刘超，以及所有对EasyPR贡献数据的热心同学。