mirror-github-bspeice/libcvautomation
1
0
Fork 0
mirror of https://github.com/bspeice/libcvautomation synced 2024-12-04 13:58:11 -05:00
Code Issues Releases Wiki Activity

Add instructions to install packages from Github

Browse Source
This commit is contained in:
Bradlee Speice 2012-07-24 09:26:36 -04:00
parent d31a125951
commit b6e7da30df
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
include/libcvautomation/libcvautomation.h.in
View File

@ -75,6 +75,44 @@ typedef struct {
* \section how_it_works How Libcvautomation Works
* Libcvautomation represents two software products coming together - <a href="http://opencv.willowgarage.com/wiki/">OpenCV</a> and the <a href="http://www.x.org/docs/Xext/xtest.pdf">XTest extension</a> to the X11 server. OpenCV is used for image recognition, and XTest is used to actually drive the X server. You can dig into \ref libcvautomation-xtest.h to get an idea of what all this library is capable of. <br>
* Basically what happens is that for whenever you need to do image recognition, OpenCV is used to find the images, and XTest is used to generate any events needed. Libcvautomation is mostly a wrapper to integrate both of these products, but also adds some functions like matchSubImage_X11() that allow you to match an image against the X11 root window in place. This means no more <tt>'xwd | convert "<out_name>"'</tt>.
* \section main_installing Installing Libcvautomation
* Installing Libcvautomation is easy. You can either manually install packages, add the Libcvautomation repository, or install from tarball (the first option is recommended).
* \subsection main_rpm Install Libcvautomation RPM Repository
* If you want to make sure that you're using the latest (stable) version of Libcvautomation, you can add the Libcvautomation repository to yum.
* First, a new configuration file for the Libcvautomation repository:
* \code sudo vim /etc/yum.repos.d/libcvautomation.repo \endcode
* After you have the file open, put the following content in it:
* \code [libcvautomation]
* name=Libcvautomation RPM repository
* baseurl=http://djbushido.github.com/libcvautomation/rpm
* enabled=1
* gpgcheck=0 \endcode
* And once this is done, clean out the cache, and you should be good to go!
* \code sudo yum clean all \endcode
* Finally, if you want to begin developing application tests, you will need the following packages: \c libcvautomation, and \c libcvautomation-examples.
* \subsection main_apt Install Libcvautomation APT Repository
* If you want to make sure that you're using the latest (stable) version of Libcvautomation, you can add the Libcvautomation repository to APT.
* First, open up your \c sources.list
* \code sudo vim /etc/apt/sources.list \endcode
* Add the following content at the end:
* \code #Libcvautomation Repository
* deb http://djbushido.github.com/libcvautomation/apt libcvautomation/
* deb-src http://djbushido.github.com/libcvautomation/apt libcvautomation-source/ \endcode
* Run an update to make sure your packages refresh, and then you should be good to go!
* \code sudo apt-get update \endcode
* Finally, if you want to begin developing application tests, you will need the following packages: \c libcvautomation-dev, and \c libcvautomation-examples.
* \subsection main_download Manual Download Packages
* If you want to manually download the packages, see the Github downloads page for libcvautomation: <a href="https://github.com/DjBushido/libcvautomation/downloads">https://github.com/DjBushido/libcvautomation/downloads</a>
* \subsection main_tarball Manual Tarball Installation
* If you want to install Libcvautomation via tarball, you can do that too. Download a release tarball from the Downloads page on Github: <a href="https://github.com/DjBushido/libcvautomation/downloads">https://github.com/DjBushido/libcvautomation/downloads</a>
* The source itself uses autotools, so it's incredibly easy to work with:
* \code cd <location_of_tarball>
* tar xf <tarball_file>
* cd libcvautomation-<release_number>
* ./configure
* make
* sudo make install \endcode
*
* \section main_using Using Libcvautomation And Writing Application Tests
* So how does one go about using libcvautomation? <br>
* I'm so glad you asked! I've provided a few reference programs - \c cva-match and \c cva-input - that can be used to demonstrate most of libcvautomation's capabilities. I've even provided a BASH wrapper to make it incredibly easy to use BASH with libcvautomation as well (requires that \c cva-match and \c cva-input are installed). Python bindings are on their way too. <br>