Move the sources to trunk
[opencv] / interfaces / ch / readme.txt
1 Ch OpenCV package is Ch binding to OpenCV.
2 With Ch OpenCV package, C (or C++) programs using OpenCV C functions 
3 can readily run in Ch without compilation.
4
5 The latest Ch OpenCV package can be obtained from
6     http://www.softintegration.com/products/toolkit/odbc/
7
8 Ch is an embeddable C/C++ interpreter for cross platform scripting,
9 2D/3D plotting, numerical computing and embedded scripting.
10 Ch is freely available from SoftIntegration, Inc.
11     http://www.softintegration.com/
12
13
14 Release Notes
15 --------------------------
16 Ch OpenCV 2.1, April 25, 2005
17 1) This updated Ch OpenCV supports OpenCV beta4 for both Windows and Linux
18 Ch OpenCV 2.0, March 15, 2005
19 1) This updated Ch OpenCV supports OpenCV beta4 and Ch 5.0.
20 2) ALL functions in OpenCV beta4 are supported.
21 3) ALL demo programs in OpenCV beta4 are readily to
22 run interpretively in Ch without compilation.
23 4) Ch SDK is now bundled with Ch 5.0 for easy interface
24 binary C/C++ library. Ch OpenCV in this release
25 can be updated automatically using Ch 5.0 or above
26 when OpenCV is updated by running the script\r./pkgcreate.ch.
27 using command 
28     make 
29 ----
30 Ch OpenCV 1.2, January 16, 2004
31    Support Ch 4.5
32 ----
33 Ch OpenCV 1.1, August 15, 2003
34
35
36 Contents
37 --------------------------
38 Ch OpenCV package contains the following directories
39
40 (1) chopencv - Ch OpenCV package
41 chopencv/demos       ---  OpenCV demo programs in C readily to run in Ch
42 chopencv/bin         ---  OpenCV dynamical library and commands
43 chopencv/dl          ---  dynamically loaded library
44 chopencv/include     ---  header files
45 chopencv/lib         ---  function files
46
47 (2) Files and utilities used to build Ch OpenCV package
48     using native C compiler and Ch SDK
49 c            ---  _chdl.c C wrappers and Makefile's
50 chfcreate    ---  bare OpenCV headers for creating .chf files
51 chfhandmade  ---  Ch function files in .chf for special functions 
52 demos        ---  demos to run in Ch 
53 pkgcreate.ch ---  A Ch program to update Ch OpenCV package
54 pkginstall.ch ---  A Ch program to install Ch OpenCV package
55
56
57 System Requirement 
58 --------------------------
59 (1) Ch Standard or Professional Edition version 5.0.1.12211 or higher.
60     It can be downloaded from http://www.softintegration.com.
61 (2) OpenvCV beta 4a or higher if a newer version is to be built.
62
63
64 To Build Ch OpenCV
65 --------------------------
66     This Ch OpenCV source directory should be placed at <OPENCV_HOME>/ch
67     In a command shell, type
68        make 
69
70
71 Installation Instructions:
72 --------------------------
73 (1) If Ch has not been installed in your computer,
74     install Ch from http://www.softintegration.com.
75
76 (2) There are three ways for installing Ch OpenCV package. 
77 You can use one of three methods below.
78
79 Method 1.
80     In a command shell, type
81
82        make install 
83
84 Method 2.
85 (a) Move the directory ./chopencv to CHHOME/package/chopencv, 
86     where CHHOME is the directory Ch installed.
87 (b) Assume CHHOME is C:/Ch, 
88       copy ./chopencv/include/* to CHHOME/toolkit/include dir 
89     or add
90       _ipath = stradd(_path, "C:/Ch/package/chopencv/include;");
91     in startup file _chrc, such as C:/_chrc, in your home directory.
92     If the following code fragment is in applicaton programs
93         #ifdef _CH_
94         #pragma package <chopencv>
95         #endif
96     this step is not necessary.
97
98 Method 3.
99 (a) Assume Ch OpenCV package is installed in 
100     C:/Program Files/OpenCV/ch/chopencv.
101 (b) Add a new path to the system variable _ppath for package 
102     path by adding the following statement
103     in system startup file CHHOME/config/chrc or individual 
104     user's startup file ~/_chrc 
105       _ppath = stradd(_ppath, "C:/Program Files/OpenCV/ch;");
106     Here we assume that the Ch OpenCV package is installed in 
107     the directory  C:/Program Files/OpenCV/ch/chopencv.
108 (c) Add a path for searching header files by adding
109       _ipath = stradd(_path, "C:/Program Files/OpenCV/ch/chopencv/include;");
110     in startup file _chrc, such as C:/_chrc, in your home directory.
111     If the following code fragment is in applicaton programs
112          #ifdef _CH_
113      #pragma package <opencv>
114          #endif
115     this step will not be necessary.
116
117
118 -------------------------------------------------------------
119 Run Demo Programs in Directory demos:
120 (1) start ch
121 (2) type program name such as 'delaunay.c'
122
123
124 How to update Ch OpenCV package for newer versions of OpenCV:
125 -------------------------------------------------------------
126 (1) If Ch has not been installed in your computer,
127     install Ch from http://www.softintegration.com.
128 (2) Run
129         make 
130 (3) install the newly created Ch OpenCV package by command
131         make install 
132 (4) Questions specific to using Ch SDK to update Ch OpenCV can be posted in 
133     either OpenCV discussion group or Ch discussion group at
134     http://www.softintegration.com.  
135
136 Uninstallation Instructions:
137 --------------------------
138     In a command shell, type
139
140        make uninstall