修改gitignore，写readme

Author: RCmerci

.gitignore

@@ -5,5 +5,5 @@ GRTAGS
 GTAGS
 GPATH
 a.out
-test
+source/test/test
 #*#

readme.md

@@ -5,3 +5,63 @@
 
 
 于是开坑第三个，名字就叫 regex-eng-3 好了!
+
+========================================
+
+语法：
+^                          ->  匹配开始
+$                          ->匹配结束
+\\d                        ->  [0-9]
+\\D                        ->  [^\\d]
+\\w                        ->  [a-z0-9_]
+\\W                        ->  [^\\w]
+\\s                        ->  [ \t\n\r]
+\\S                        ->  [^\\s]
+.                          ->  [^\n]
+|                          ->    或
+[...]                      ->  字符集
+*                          ->  循环至少0次，贪婪
+*?                         ->  循环至少0次，非贪婪
++                          ->  循环至少1次，贪婪 
++?                         ->  循环至少1次，非贪婪
+{min, max}                 ->  循环min至max次，贪婪 (max为空代表无穷)
+{min, max}?                ->  循环min至max次，非贪婪
+(...)                      ->  普通括号，用于改变优先级
+(?...)                     ->  匿名捕获
+(?<name>...)               ->  命名捕获
+(=...)                     ->  前向查询
+(!...)                     ->  反前向查询
+(#<name>...)               ->  表达式命名 
+(&<name>)                  ->  表达式使用（即替换成对应表达式）
+
+==========================================
+API:
+class RegexResult:
+
+Bool() -> bool
+Group() -> 匹配到的字符串数组
+Group(index) -> 匿名捕获的字符串数组
+Group(name)  -> 命名捕获的字符串数组
+
+
+class Regex:
+
+Match(testString, beginIndex=0) -> RegexResult
+Search(testString, beginIndex=0) -> RegexResult
+FindAll(testString, beginIndex=0) -> RegexResult
+Replace(testString, replaceStr, replaceTime=1, beginIndex=0) -> resultString
+ReplaceAll(testString, replaceStr, beginIndex=0) -> resultString
+
+============================================
+
+examples:
+auto rst = Regex("^.+?@(?<type>.+?)\\.(?(com|cn))$").Match("563748559@qq.com");
+rst.Group().size() == 1;
+rst.Group()[0] == "563748559@qq.com";
+rst.Group(1).size() == 1;
+rst.Group(1)[0] == "com";
+rst.Group("type").size() == 1;
+rst.Group("type")[0] == "563748559";
+
+more examples in source/test/test.cpp
+

source/test/test.cpp

@@ -687,17 +687,19 @@ int main()
 
 	}
 
-
 	{
 		std::string testString =
 			"<dt><a href=\"http://bbs.uestc.edu.cn/forum.php?mod=forumdisplay&fid=219\">出国留学</a><em class=\"xw0 xi1\" title=\"今日\"> (今日: 9)</em></dt>""<dd><a href=\"http://bbs.uestc.edu.cn/forum.php?mod=redirect&amp;tid=1570205&amp;goto=lastpost#lastpost\" class=\"xi2\">ETH网申</a></dd><dd><cite>by: <a href=\"http://bbs.uestc.edu.cn/home.php?mod=space&username=camelluxin\">camelluxin</a> [<span title=\"2015-11-8 21:30\">1&nbsp;小时前</span>]</cite></dd>";
 		Regex regex("href=\"(?<url>https?://.+?)\"");
 		auto result = regex.FindAll(testString);
 		assert(result.Bool() == true);
-		for (auto i : result.Group("url")) {
+
+	}
+	{
+		auto rst = Regex("(ab){2,}").FindAll("yyababababababababbab");
+		for (auto i :rst.Group()) {
 			std::cout<<i<<std::endl;
 		}
-
 	}
 	std::cout<<"all test case passed."<<std::endl;
 }