-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
176 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
CanvasCV documentation {#mainpage} | ||
====================== | ||
CanvasCV gives you a non intrusive, simple and extendable GUI system for OpenCV, based on OpenCV. | ||
It is released under the same license terms as OpenCV, so you can basically use it for anything. | ||
|
||
Table of contents | ||
* @ref nutshell | ||
* @ref install | ||
* @ref multithreading | ||
* @ref tutorials |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
Installation {#install} | ||
============ | ||
|
||
Build and install | ||
----------------- | ||
## Linux Building / Installing | ||
### Build dependencies | ||
Make sure these are installed first and that their executables are **in your path**: | ||
* **cmake** - should already be installed since you built OpenCV by yourself. | ||
* **git** (optional) - you can also download the sources from GitHub. | ||
|
||
### Prepare to build | ||
|
||
``` | ||
git clone https://github.com/sagi-z/CanvasCV.git | ||
cd CanvasCV | ||
git checkout tags/1.0.0 | ||
mkdir build | ||
cd build | ||
``` | ||
|
||
### By default cmake is building without the C++ examples | ||
|
||
``` | ||
cmake .. | ||
make | ||
``` | ||
|
||
### Here is how to build the examples | ||
|
||
``` | ||
cmake -DBUILD_EXAMPLES=ON .. | ||
make | ||
``` | ||
|
||
### Install option 1 for Linux (from the build directory): | ||
|
||
``` | ||
sudo make install | ||
``` | ||
|
||
### C++ Install option 2 for Linux - cleaner (from the build directory): | ||
|
||
``` | ||
cpack -G DEB | ||
sudo dpkg -i ./canvascv-1.0.0-Linux.deb | ||
``` | ||
|
||
C++ Usage | ||
--------- | ||
### Linux | ||
Assuming installation in '/usr/local', add to cflags '-I/usr/local/include' and to link flags '-L/usr/local/lib -lcanvascv' | ||
|
||
Here is a minimal *CMakeLists.txt* example: | ||
``` | ||
CMAKE_MINIMUM_REQUIRED(VERSION 2.8) | ||
PROJECT(myapp) | ||
FIND_PACKAGE(OpenCV 3.1.0 REQUIRED) | ||
INCLUDE_DIRECTORIES(${OpenCV_INCLUDE_DIRS} "/usr/local/include") | ||
ADD_EXECUTABLE(myapp main.cpp) | ||
FIND_LIBRARY(CanvasCV_LIB canvascv "/usr/local/lib") | ||
TARGET_LINK_LIBRARIES (myapp ${CanvasCV_LIB} ${OpenCV_LIBS}) | ||
``` | ||
|
||
### Windows | ||
make sure the include path and link path and library are set correctly. | ||
|
||
### C++ code example | ||
See example files in the doxygen Docs | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
Installation {#install} | ||
============ | ||
|
||
Build and install | ||
----------------- | ||
## Linux Building / Installing | ||
### Build dependencies | ||
Make sure these are installed first and that their executables are **in your path**: | ||
* **cmake** - should already be installed since you built OpenCV by yourself. | ||
* **git** (optional) - you can also download the sources from GitHub. | ||
|
||
### Prepare to build | ||
|
||
``` | ||
git clone https://github.com/sagi-z/CanvasCV.git | ||
cd CanvasCV | ||
git checkout tags/@CPACK_PACKAGE_VERSION@ | ||
mkdir build | ||
cd build | ||
``` | ||
|
||
### By default cmake is building without the C++ examples | ||
|
||
``` | ||
cmake .. | ||
make | ||
``` | ||
|
||
### Here is how to build the examples | ||
|
||
``` | ||
cmake -DBUILD_EXAMPLES=ON .. | ||
make | ||
``` | ||
|
||
### Install option 1 for Linux (from the build directory): | ||
|
||
``` | ||
sudo make install | ||
``` | ||
|
||
### C++ Install option 2 for Linux - cleaner (from the build directory): | ||
|
||
``` | ||
cpack -G DEB | ||
sudo dpkg -i ./canvascv-@[email protected] | ||
``` | ||
|
||
C++ Usage | ||
--------- | ||
### Linux | ||
Assuming installation in '/usr/local', add to cflags '-I/usr/local/include' and to link flags '-L/usr/local/lib -lcanvascv' | ||
|
||
Here is a minimal *CMakeLists.txt* example: | ||
``` | ||
CMAKE_MINIMUM_REQUIRED(VERSION 2.8) | ||
|
||
PROJECT(myapp) | ||
|
||
FIND_PACKAGE(OpenCV 3.1.0 REQUIRED) | ||
|
||
INCLUDE_DIRECTORIES(${OpenCV_INCLUDE_DIRS} "/usr/local/include") | ||
|
||
ADD_EXECUTABLE(myapp main.cpp) | ||
|
||
FIND_LIBRARY(CanvasCV_LIB canvascv "/usr/local/lib") | ||
TARGET_LINK_LIBRARIES (myapp ${CanvasCV_LIB} ${OpenCV_LIBS}) | ||
``` | ||
|
||
### Windows | ||
make sure the include path and link path and library are set correctly. | ||
|
||
### C++ code example | ||
See example files in the doxygen Docs | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Multithreading {#multithreading} | ||
============== | ||
As GUI toolkits go, they are mostly not multithreaded. | ||
The other threads do they work and then GUI handling (update/paint/callbacks) is done in a dedicated thread. | ||
* [see a related example in this blog post](https://www.theimpossiblecode.com/blog/faster-opencv-smiles-tbb "dedicated GUI thread"). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
CanvasCV Tutorials {#tutorials} | ||
================== | ||
(see also the examples section) | ||
* @subpage on screen text tutorial | ||
* @subpage using buttons | ||
* [More tutorials which haven't made it into the official documentation yet](https://sagi-z.github.io/CanvasCV/tutorials "more tutorials"). |