Skip to content

Commit 3791f84

Browse files
committed
[doc] removing details from INSTALL and link to rtd
1 parent 743c9af commit 3791f84

File tree

1 file changed

+1
-30
lines changed

1 file changed

+1
-30
lines changed

INSTALL.md

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Building instructions
44

5+
For a detailed guide on building the library check the [online documentation](https://cctag.readthedocs.io/).
56

67
Required tools:
78
* CMake >= 3.14 to build the code
@@ -14,12 +15,6 @@ Optional tool:
1415
* CUDA >= 9.0
1516
Note: On Windows, there are compatibility issues to build the GPU part due to conflicts between msvc/nvcc/thrust/eigen/boost.
1617

17-
### Getting the sources:
18-
19-
```shell
20-
$ git clone https://github.com/alicevision/CCTag.git
21-
```
22-
2318
### Dependencies
2419

2520
Most of the dependencies can be installed from the common repositories (apt, yum etc):
@@ -29,30 +24,6 @@ Most of the dependencies can be installed from the common repositories (apt, yum
2924
- OpenCV >= 3.1
3025
- TBB >= 4.0
3126

32-
On a recent Ubuntu-like distribution (e.g. 14.04), you may want to try to run:
33-
```shell
34-
$ sudo apt-get install g++ git-all libpng12-dev libjpeg-dev libeigen3-dev libboost-atomic-dev libboost-chrono-dev libboost-date-time-dev libboost-dev libboost-program-options-dev libboost-exception-dev libboost-filesystem-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev libboost-timer-dev libtbb-dev
35-
```
36-
37-
OpenCV need to be compiled separately and installed in some `OPENCV_INSTALL` path. Then, when running cmake you need to provide the path to the location where `OpenCVConfig.cmake` is installed, usually `${OPENCV_INSTALL}/share/share/OpenCV/` (see below).
38-
39-
CCTag contains code optimized for AVX2 instruction set, which significantly increases detection performance. You can enable it with the option: `cmake -DCCTAG_ENABLE_SIMD_AVX2=ON`.
40-
41-
----------
42-
43-
### Run the building process
44-
45-
You now just need to be in the CCTag folder and run cmake:
46-
```bash
47-
$ mkdir build && cd build
48-
$ cmake .. -DOpenCV_DIR=${OPENCV_INSTALL}/share/share/OpenCV/
49-
$ make -j `nproc`
50-
```
51-
52-
Use `-DCCTAG_WITH_CUDA:BOOL=ON` to enable (default) or disable the cuda support. On Windows, it must be set to `OFF` if the Eigen version is < 3.3.9
53-
54-
If you want to install the library to, say, a CCTAG_INSTALL path, just add `-DCMAKE_INSTALL_PREFIX=$CCTAG_INSTALL` at cmake command line.
55-
If you want to build CCTag as a shared library: `-DBUILD_SHARED_LIBS=ON`.
5627

5728
----------
5829

0 commit comments

Comments
 (0)