Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 227d7d3 commit 930870f0f10a5dc6597c46601434867b0261f7d7 @aleator committed Mar 23, 2012
Showing with 25 additions and 6 deletions.
  1. +25 −6 README.md
View
31 README.md
@@ -1,12 +1,31 @@
About
=====
-This is a machine vision package that wraps some functionality of OpenCV
-library. This package has been developed for personal use and is not meant to
-be a complete wrapper. It also includes some things not in OpenCV. .
-Currently this package is quite dirty and requires much work on documentation
-and code clean-up, but is somewhat tested. The scarce Documentation is
-available at <http://users.jyu.fi/~aleator/CV-0.3.0.2/html/index.html>
+This is a machine vision package that is implemented on top of the [OpenCV C library]
+library.
+
+How To Install
+==============
+
+The main installation instructions are detailed in the [Project Wiki]. In short, install
+GHC 7.4.1, cabal install, c2hs and c version of opencv and your good to go.
+There is also an [example installation transcript with all the gory details] in the wiki.
+
+[example installation with all the gory details]: https://github.com/aleator/CV/wiki/One-go-at-installing-CV
+
+How To Use
+==========
+
+The Documentation is available at <http://aleator.github.com/CV/>
+
+Screenshots? Examples?
+======================
+
+There are some screenshots at <http://aleator.github.com/CV/> and the [`examples`] directory of
+this project contains a plenty of small sample programs.
+
+[`examples`]:https://github.com/aleator/CV/tree/master/examples
+[OpenCV C library]: http://opencv.willowgarage.com
Changelog
---------

0 comments on commit 930870f

Please sign in to comment.