oorb 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +0 -1
- data/.yardopts +1 -0
- data/Gemfile +0 -1
- data/doc/OORB.html +542 -0
- data/doc/Oorb.html +117 -0
- data/doc/_index.html +116 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.CODE_OF_CONDUCT.html +127 -0
- data/doc/file.LICENSE.html +73 -0
- data/doc/file.README.html +143 -0
- data/doc/file_list.html +66 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +143 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +87 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/oorb.rb +3 -3
- data/lib/oorb/version.rb +1 -1
- metadata +20 -1
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: CODE_OF_CONDUCT
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '';
|
|
20
|
+
framesUrl = "frames.html#!file.CODE_OF_CONDUCT.html";
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="_index.html">Index</a> »
|
|
35
|
+
<span class="title">File: CODE_OF_CONDUCT</span>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">
|
|
42
|
+
|
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
|
44
|
+
href="class_list.html">
|
|
45
|
+
Class List
|
|
46
|
+
</a>
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
|
49
|
+
href="method_list.html">
|
|
50
|
+
Method List
|
|
51
|
+
</a>
|
|
52
|
+
|
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
|
54
|
+
href="file_list.html">
|
|
55
|
+
File List
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><div id='filecontents'>
|
|
65
|
+
<h1 id="label-Contributor+Code+of+Conduct">Contributor Code of Conduct</h1>
|
|
66
|
+
|
|
67
|
+
<p>As contributors and maintainers of this project, and in the interest of
|
|
68
|
+
fostering an open and welcoming community, we pledge to respect all people
|
|
69
|
+
who contribute through reporting issues, posting feature requests, updating
|
|
70
|
+
documentation, submitting pull requests or patches, and other activities.</p>
|
|
71
|
+
|
|
72
|
+
<p>We are committed to making participation in this project a harassment-free
|
|
73
|
+
experience for everyone, regardless of level of experience, gender, gender
|
|
74
|
+
identity and expression, sexual orientation, disability, personal
|
|
75
|
+
appearance, body size, race, ethnicity, age, religion, or nationality.</p>
|
|
76
|
+
|
|
77
|
+
<p>Examples of unacceptable behavior by participants include:</p>
|
|
78
|
+
<ul><li>
|
|
79
|
+
<p>The use of sexualized language or imagery</p>
|
|
80
|
+
</li><li>
|
|
81
|
+
<p>Personal attacks</p>
|
|
82
|
+
</li><li>
|
|
83
|
+
<p>Trolling or insulting/derogatory comments</p>
|
|
84
|
+
</li><li>
|
|
85
|
+
<p>Public or private harassment</p>
|
|
86
|
+
</li><li>
|
|
87
|
+
<p>Publishing other's private information, such as physical or electronic
|
|
88
|
+
addresses, without explicit permission</p>
|
|
89
|
+
</li><li>
|
|
90
|
+
<p>Other unethical or unprofessional conduct</p>
|
|
91
|
+
</li></ul>
|
|
92
|
+
|
|
93
|
+
<p>Project maintainers have the right and responsibility to remove, edit, or
|
|
94
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
95
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
96
|
+
permanently any contributor for other behaviors that they deem
|
|
97
|
+
inappropriate, threatening, offensive, or harmful.</p>
|
|
98
|
+
|
|
99
|
+
<p>By adopting this Code of Conduct, project maintainers commit themselves to
|
|
100
|
+
fairly and consistently applying these principles to every aspect of
|
|
101
|
+
managing this project. Project maintainers who do not follow or enforce the
|
|
102
|
+
Code of Conduct may be permanently removed from the project team.</p>
|
|
103
|
+
|
|
104
|
+
<p>This code of conduct applies both within project spaces and in public
|
|
105
|
+
spaces when an individual is representing the project or its community.</p>
|
|
106
|
+
|
|
107
|
+
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
108
|
+
reported by contacting a project maintainer at claytonflesher@gmail.com.
|
|
109
|
+
All complaints will be reviewed and investigated and will result in a
|
|
110
|
+
response that is deemed necessary and appropriate to the circumstances.
|
|
111
|
+
Maintainers are obligated to maintain confidentiality with regard to the
|
|
112
|
+
reporter of an incident.</p>
|
|
113
|
+
|
|
114
|
+
<p>This Code of Conduct is adapted from the <a
|
|
115
|
+
href="http://contributor-covenant.org">Contributor Covenant</a>, version
|
|
116
|
+
1.3.0, available at <a
|
|
117
|
+
href="http://contributor-covenant.org/version/1/3/0/">contributor-covenant.org/version/1/3/0/</a></p>
|
|
118
|
+
</div></div>
|
|
119
|
+
|
|
120
|
+
<div id="footer">
|
|
121
|
+
Generated on Sat Jun 11 11:35:54 2016 by
|
|
122
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
123
|
+
0.8.7.6 (ruby-2.3.1).
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
</body>
|
|
127
|
+
</html>
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: LICENSE
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '';
|
|
20
|
+
framesUrl = "frames.html#!file.LICENSE.html";
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="_index.html">Index</a> »
|
|
35
|
+
<span class="title">File: LICENSE</span>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">
|
|
42
|
+
|
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
|
44
|
+
href="class_list.html">
|
|
45
|
+
Class List
|
|
46
|
+
</a>
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
|
49
|
+
href="method_list.html">
|
|
50
|
+
Method List
|
|
51
|
+
</a>
|
|
52
|
+
|
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
|
54
|
+
href="file_list.html">
|
|
55
|
+
File List
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2016 Calvyn82<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the "Software"), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.</div></div>
|
|
65
|
+
|
|
66
|
+
<div id="footer">
|
|
67
|
+
Generated on Sat Jun 11 11:35:54 2016 by
|
|
68
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
69
|
+
0.8.7.6 (ruby-2.3.1).
|
|
70
|
+
</div>
|
|
71
|
+
|
|
72
|
+
</body>
|
|
73
|
+
</html>
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '';
|
|
20
|
+
framesUrl = "frames.html#!file.README.html";
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="_index.html">Index</a> »
|
|
35
|
+
<span class="title">File: README</span>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">
|
|
42
|
+
|
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
|
44
|
+
href="class_list.html">
|
|
45
|
+
Class List
|
|
46
|
+
</a>
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
|
49
|
+
href="method_list.html">
|
|
50
|
+
Method List
|
|
51
|
+
</a>
|
|
52
|
+
|
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
|
54
|
+
href="file_list.html">
|
|
55
|
+
File List
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><div id='filecontents'>
|
|
65
|
+
<h1 id="label-Oorb">Oorb</h1>
|
|
66
|
+
|
|
67
|
+
<p>OCR Optimized Regex Builder is a command line tool for taking user input
|
|
68
|
+
and converting it to regular expressions optimized for capturing characters
|
|
69
|
+
that are commonly mistaken by optical character recognition engines.</p>
|
|
70
|
+
|
|
71
|
+
<h2 id="label-Installation+as+a+command+line+appliction">Installation as a command line appliction</h2>
|
|
72
|
+
|
|
73
|
+
<p>Clone this repository</p>
|
|
74
|
+
|
|
75
|
+
<pre class="code ruby"><code class="ruby">$ git clone https://github.com/Calvyn82/oorb</code></pre>
|
|
76
|
+
|
|
77
|
+
<p>Navigate to the root directory, run the test suite, and install the
|
|
78
|
+
application.</p>
|
|
79
|
+
|
|
80
|
+
<pre class="code ruby"><code class="ruby">$ cd oorb
|
|
81
|
+
$ bundle install
|
|
82
|
+
$ bundle exec rake
|
|
83
|
+
$ bundle exec rake install</code></pre>
|
|
84
|
+
|
|
85
|
+
<h2 id="label-Installation+as+part+of+a+Ruby+application">Installation as part of a Ruby application</h2>
|
|
86
|
+
|
|
87
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
88
|
+
|
|
89
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>oorb</span><span class='tstring_end'>'</span></span>
|
|
90
|
+
</code></pre>
|
|
91
|
+
|
|
92
|
+
<p>And then execute:</p>
|
|
93
|
+
|
|
94
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
|
95
|
+
|
|
96
|
+
<p>Or install it yourself as:</p>
|
|
97
|
+
|
|
98
|
+
<pre class="code ruby"><code class="ruby">$ gem install oorb</code></pre>
|
|
99
|
+
|
|
100
|
+
<h2 id="label-Usage+as+a+command+line+application">Usage as a command line application</h2>
|
|
101
|
+
|
|
102
|
+
<pre class="code ruby"><code class="ruby">$ oorb</code></pre>
|
|
103
|
+
|
|
104
|
+
<p>To exit the application, use Ctrl-c.</p>
|
|
105
|
+
|
|
106
|
+
<h2 id="label-Development">Development</h2>
|
|
107
|
+
|
|
108
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install
|
|
109
|
+
dependencies. Then, run <code>bin/rake</code>, <code>bin/rake test</code>,
|
|
110
|
+
<code>bundle exec rake</code> or <code>bundle exec rake test</code> to run
|
|
111
|
+
the tests. You can also run <code>bin/console</code> for an interactive
|
|
112
|
+
prompt that will allow you to experiment.</p>
|
|
113
|
+
|
|
114
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake
|
|
115
|
+
install</code>. To release a new version, update the version number in
|
|
116
|
+
<code>version.rb</code>, and then run <code>bundle exec rake
|
|
117
|
+
release</code>, which will create a git tag for the version, push git
|
|
118
|
+
commits and tags, and push the <code>.gem</code> file to <a
|
|
119
|
+
href="https://rubygems.org">rubygems.org</a>.</p>
|
|
120
|
+
|
|
121
|
+
<h2 id="label-Contributing">Contributing</h2>
|
|
122
|
+
|
|
123
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a
|
|
124
|
+
href="https://github.com/Calvyn82/oorb">github.com/Calvyn82/oorb</a>. This
|
|
125
|
+
project is intended to be a safe, welcoming space for collaboration, and
|
|
126
|
+
contributors are expected to adhere to the <a
|
|
127
|
+
href="http://contributor-covenant.org">Contributor Covenant</a> code of
|
|
128
|
+
conduct.</p>
|
|
129
|
+
|
|
130
|
+
<h2 id="label-License">License</h2>
|
|
131
|
+
|
|
132
|
+
<p>The gem is available as open source under the terms of the <a
|
|
133
|
+
href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
134
|
+
</div></div>
|
|
135
|
+
|
|
136
|
+
<div id="footer">
|
|
137
|
+
Generated on Sat Jun 11 11:35:54 2016 by
|
|
138
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
139
|
+
0.8.7.6 (ruby-2.3.1).
|
|
140
|
+
</div>
|
|
141
|
+
|
|
142
|
+
</body>
|
|
143
|
+
</html>
|
data/doc/file_list.html
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<title>File List</title>
|
|
19
|
+
<base id="base_target" target="_parent" />
|
|
20
|
+
</head>
|
|
21
|
+
<body>
|
|
22
|
+
<script type="text/javascript" charset="utf-8">
|
|
23
|
+
var hasFrames = false;
|
|
24
|
+
try {
|
|
25
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
26
|
+
} catch (e) { }
|
|
27
|
+
if (hasFrames) {
|
|
28
|
+
document.getElementById('base_target').target = 'main';
|
|
29
|
+
document.body.className = 'frames';
|
|
30
|
+
}
|
|
31
|
+
</script>
|
|
32
|
+
<div id="content">
|
|
33
|
+
<h1 id="full_list_header">File List</h1>
|
|
34
|
+
<div id="nav">
|
|
35
|
+
|
|
36
|
+
<span><a target="_self" href="class_list.html">
|
|
37
|
+
Classes
|
|
38
|
+
</a></span>
|
|
39
|
+
|
|
40
|
+
<span><a target="_self" href="method_list.html">
|
|
41
|
+
Methods
|
|
42
|
+
</a></span>
|
|
43
|
+
|
|
44
|
+
<span><a target="_self" href="file_list.html">
|
|
45
|
+
Files
|
|
46
|
+
</a></span>
|
|
47
|
+
|
|
48
|
+
</div>
|
|
49
|
+
<div id="search">Search: <input type="text" /></div>
|
|
50
|
+
|
|
51
|
+
<ul id="full_list" class="file">
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
<li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
<li class="r2"><span class="object_link"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></a></li>
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<li class="r1"><span class="object_link"><a href="file.CODE_OF_CONDUCT.html" title="CODE_OF_CONDUCT">CODE_OF_CONDUCT</a></a></li>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</ul>
|
|
64
|
+
</div>
|
|
65
|
+
</body>
|
|
66
|
+
</html>
|
data/doc/frames.html
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
|
3
|
+
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|
7
|
+
<title>Documentation by YARD 0.8.7.6</title>
|
|
8
|
+
</head>
|
|
9
|
+
<script type="text/javascript" charset="utf-8">
|
|
10
|
+
window.onload = function() {
|
|
11
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
|
12
|
+
var name = match ? match[1] : 'index.html';
|
|
13
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
|
14
|
+
document.writeln('<frameset cols="20%,*">' +
|
|
15
|
+
'<frame name="list" src="class_list.html" />' +
|
|
16
|
+
'<frame name="main" src="' + escape(name) + '" />' +
|
|
17
|
+
'</frameset>');
|
|
18
|
+
}
|
|
19
|
+
</script>
|
|
20
|
+
<noscript>
|
|
21
|
+
<frameset cols="20%,*">
|
|
22
|
+
<frame name="list" src="class_list.html" />
|
|
23
|
+
<frame name="main" src="index.html" />
|
|
24
|
+
</frameset>
|
|
25
|
+
</noscript>
|
|
26
|
+
</html>
|
data/doc/index.html
ADDED
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '';
|
|
20
|
+
framesUrl = "frames.html#!file.README.html";
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="_index.html">Index</a> »
|
|
35
|
+
<span class="title">File: README</span>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">
|
|
42
|
+
|
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
|
44
|
+
href="class_list.html">
|
|
45
|
+
Class List
|
|
46
|
+
</a>
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
|
49
|
+
href="method_list.html">
|
|
50
|
+
Method List
|
|
51
|
+
</a>
|
|
52
|
+
|
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
|
54
|
+
href="file_list.html">
|
|
55
|
+
File List
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><div id='filecontents'>
|
|
65
|
+
<h1 id="label-Oorb">Oorb</h1>
|
|
66
|
+
|
|
67
|
+
<p>OCR Optimized Regex Builder is a command line tool for taking user input
|
|
68
|
+
and converting it to regular expressions optimized for capturing characters
|
|
69
|
+
that are commonly mistaken by optical character recognition engines.</p>
|
|
70
|
+
|
|
71
|
+
<h2 id="label-Installation+as+a+command+line+appliction">Installation as a command line appliction</h2>
|
|
72
|
+
|
|
73
|
+
<p>Clone this repository</p>
|
|
74
|
+
|
|
75
|
+
<pre class="code ruby"><code class="ruby">$ git clone https://github.com/Calvyn82/oorb</code></pre>
|
|
76
|
+
|
|
77
|
+
<p>Navigate to the root directory, run the test suite, and install the
|
|
78
|
+
application.</p>
|
|
79
|
+
|
|
80
|
+
<pre class="code ruby"><code class="ruby">$ cd oorb
|
|
81
|
+
$ bundle install
|
|
82
|
+
$ bundle exec rake
|
|
83
|
+
$ bundle exec rake install</code></pre>
|
|
84
|
+
|
|
85
|
+
<h2 id="label-Installation+as+part+of+a+Ruby+application">Installation as part of a Ruby application</h2>
|
|
86
|
+
|
|
87
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
88
|
+
|
|
89
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>oorb</span><span class='tstring_end'>'</span></span>
|
|
90
|
+
</code></pre>
|
|
91
|
+
|
|
92
|
+
<p>And then execute:</p>
|
|
93
|
+
|
|
94
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
|
95
|
+
|
|
96
|
+
<p>Or install it yourself as:</p>
|
|
97
|
+
|
|
98
|
+
<pre class="code ruby"><code class="ruby">$ gem install oorb</code></pre>
|
|
99
|
+
|
|
100
|
+
<h2 id="label-Usage+as+a+command+line+application">Usage as a command line application</h2>
|
|
101
|
+
|
|
102
|
+
<pre class="code ruby"><code class="ruby">$ oorb</code></pre>
|
|
103
|
+
|
|
104
|
+
<p>To exit the application, use Ctrl-c.</p>
|
|
105
|
+
|
|
106
|
+
<h2 id="label-Development">Development</h2>
|
|
107
|
+
|
|
108
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install
|
|
109
|
+
dependencies. Then, run <code>bin/rake</code>, <code>bin/rake test</code>,
|
|
110
|
+
<code>bundle exec rake</code> or <code>bundle exec rake test</code> to run
|
|
111
|
+
the tests. You can also run <code>bin/console</code> for an interactive
|
|
112
|
+
prompt that will allow you to experiment.</p>
|
|
113
|
+
|
|
114
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake
|
|
115
|
+
install</code>. To release a new version, update the version number in
|
|
116
|
+
<code>version.rb</code>, and then run <code>bundle exec rake
|
|
117
|
+
release</code>, which will create a git tag for the version, push git
|
|
118
|
+
commits and tags, and push the <code>.gem</code> file to <a
|
|
119
|
+
href="https://rubygems.org">rubygems.org</a>.</p>
|
|
120
|
+
|
|
121
|
+
<h2 id="label-Contributing">Contributing</h2>
|
|
122
|
+
|
|
123
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a
|
|
124
|
+
href="https://github.com/Calvyn82/oorb">github.com/Calvyn82/oorb</a>. This
|
|
125
|
+
project is intended to be a safe, welcoming space for collaboration, and
|
|
126
|
+
contributors are expected to adhere to the <a
|
|
127
|
+
href="http://contributor-covenant.org">Contributor Covenant</a> code of
|
|
128
|
+
conduct.</p>
|
|
129
|
+
|
|
130
|
+
<h2 id="label-License">License</h2>
|
|
131
|
+
|
|
132
|
+
<p>The gem is available as open source under the terms of the <a
|
|
133
|
+
href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
134
|
+
</div></div>
|
|
135
|
+
|
|
136
|
+
<div id="footer">
|
|
137
|
+
Generated on Sat Jun 11 11:35:54 2016 by
|
|
138
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
139
|
+
0.8.7.6 (ruby-2.3.1).
|
|
140
|
+
</div>
|
|
141
|
+
|
|
142
|
+
</body>
|
|
143
|
+
</html>
|