Skip to content

Commit fef1f12

Browse files
committed
[doc] updated and fixed INSTALL
1 parent 3dccc4d commit fef1f12

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

INSTALL.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,26 @@
55
For a detailed guide on building the library check the [online documentation](https://cctag.readthedocs.io/).
66

77
Required tools:
8+
89
* CMake >= 3.14 to build the code
910
* Git
1011
* C/C++ compiler with C++14 support
11-
* see here: https://en.cppreference.com/w/cpp/compiler_support
12-
* TLDR gcc >= 5, clang >= 3.4, msvc >= 2017
12+
* see here: <https://en.cppreference.com/w/cpp/compiler_support>
13+
* TLDR gcc >= 5, clang >= 3.4, msvc >= 2017
1314

1415
Optional tool:
15-
* CUDA >= 9.0
16+
17+
* CUDA >= 9.0
1618
Note: On Windows, there are compatibility issues to build the GPU part due to conflicts between msvc/nvcc/thrust/eigen/boost.
1719

18-
### Dependencies
20+
### Dependencies
1921

2022
Most of the dependencies can be installed from the common repositories (apt, yum etc):
2123

22-
- Eigen3 (libeigen3-dev) >= 3.3.4 (NOTE: in order to have Cuda support on Windows, at least version 3.3.9 is required)
23-
- Boost >= 1.66 ([accumulators, chrono, core, date-time, exception, filesystem, math, program-options, ptr-container, system, serialization, stacktrace, timer, thread]-dev)
24-
- OpenCV >= 3.1
25-
- TBB >= 2021.5.0
26-
24+
* Eigen3 (libeigen3-dev) >= 3.3.4 (NOTE: in order to have Cuda support on Windows, at least version 3.3.9 is required)
25+
* Boost >= 1.66 ([accumulators, core, date-time, exception, filesystem, math, program-options, ptr-container, system, serialization, stacktrace, timer, thread]-dev)
26+
* OpenCV >= 3.1
27+
* TBB >= 2021.5.0
2728

2829
----------
2930

@@ -53,18 +54,19 @@ cmake .. -DCCTag_DIR=$CCTAG_INSTALL/lib/cmake/CCTag/
5354

5455
## Docker Image
5556

56-
A docker image can be built using the Ubuntu based [Dockerfile](Dockerfile),which is based on nvidia/cuda image (https://hub.docker.com/r/nvidia/cuda/)
57+
A docker image can be built using the Ubuntu based [Dockerfile](Dockerfile),which is based on nvidia/cuda image (<https://hub.docker.com/r/nvidia/cuda/>)
5758

58-
A parameter `CUDA_TAG` can be passed when building the image to select the ubuntu and cuda version.
59+
A parameter `CUDA_TAG` can be passed when building the image to select the ubuntu and cuda version.
5960
For example to create a ubuntu 16.04 with cuda 8.0 for development, use
60-
```
61+
62+
```bash
6163
docker build --build-arg CUDA_TAG=8.0-devel --tag cctag .
6264
```
6365

6466
The complete list of available tags can be found on the nvidia [dockerhub page](https://hub.docker.com/r/nvidia/cuda/)
65-
In order to run the image nvidia docker is needed: see the installation instruction here https://github.com/nvidia/nvidia-docker/wiki/Installation-(version-2.0)
67+
In order to run the image nvidia docker is needed: see the installation instruction here <https://github.com/nvidia/nvidia-docker/wiki/Installation-(version-2.0)>
6668
Once installed, the docker can be run, e.g., in interactive mode with
6769

68-
```
70+
```bash
6971
docker run -it --runtime=nvidia cctag
7072
```

0 commit comments

Comments
 (0)