ocr/README at master · ChengduoZhao/ocr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
****************************
** Open Community Runtime **
****************************


*************************
** Directory structure **
*************************

    - examples/
        helloworld and alike.
    - inc/
        user-level ocr api header files
    - src/
        ocr implementation source code
    - tests/
        Non-regression tests


*******************************
** Installation instructions **
*******************************

See the 'INSTALL' file


******************************
** Using OCR     		    **
******************************

This section's instructions requires you have set the
OCR_INSTALL environment variable as described in the
INSTALL file.


*** Compiling code

OCR is built as a library your program must link with.
The actual command line may differ on different OS and compilers.

The following command line can be used on a typical Linux X86
distribution with gcc. It generates a binary named 'helloworld'
that links with the OCR library.

	$> gcc -L${OCR_INSTALL}/lib -I${OCR_INSTALL}/include -locr -o helloworld helloworld.c


*** Running code

OCR needs a runtime configuration file that describes how
the runtime must be layed out for the particular machine it
is executed on.

A default configuration file and some examples are provided
under ${OCR_INSTALL}/config

The configuration file can be given to the runtime either
through the OCR_CONFIG environment variable or through the
command line parameter -ocr:cfg <filename>

Note: command line parameters always override values defined
in environment variables.

Using environment variable options:

	$> OCR_CONFIG=<filename>; ./helloworld

Using command line options:

	$> ./helloworld -ocr:cfg <filename>

>To get a list of available OCR options:

	$> ./helloworld -ocr:help


******************************
** Testing the distribution **
******************************

*** Non-regression tests

The 'tests' folder contains a collection of non-regression tests.
After installing and setting OCR environment variables, one can
run non-regression tests running the 'ocrTests' script.

*** examples

After installing and setting OCR environment variables, examples
located under the 'examples' folder can be tested for regressions
using the 'ocrTestsExamples' script.


***********************
** Known Limitations **
***********************

- The deque-based workpile does not resize automatically
    - the macro INC_DEQUE_CAPACITY defined in deque.h can be customized

*******************
** Documentation **
*******************

To generate documentation, type 'doxygen ocr.dox'. HTML documentation will be
generated in doc/html and LaTeX documentation in doc/latex. A PDF can be generated
from the LaTeX documentation by typing 'make' in that directory