@@ -33,6 +33,7 @@ See: [depthai-core dependencies](https://github.com/luxonis/depthai-core#depende
3333
3434To build a shared library from source perform the following:
3535```
36+ git submodule update --init --recursive
3637mkdir build && cd build
3738cmake .. [-D PYTHON_EXECUTABLE=/full/path/to/python]
3839cmake --build . --parallel
@@ -54,6 +55,7 @@ python3 -m pip install .
5455
5556To run the tests build the library with the following options
5657```
58+ git submodule update --init --recursive
5759mkdir build_tests && cd build_tests
5860cmake .. -D DEPTHAI_PYTHON_ENABLE_TESTS=ON -D DEPTHAI_PYTHON_ENABLE_EXAMPLES=ON -D DEPTHAI_PYTHON_TEST_EXAMPLES=ON
5961cmake --build . --parallel
6870- Raspbian 10;
6971- macOS 10.14.6, 10.15.4;
7072
71-
7273### Building documentation
7374
7475- ** Using [ Docker] ( https://docs.docker.com/ ) (with [ Docker Compose] ( https://docs.docker.com/compose/install/ ) )**
@@ -78,36 +79,35 @@ ctest
7879 sudo docker-compose build
7980 sudo docker-compose up
8081 ```
81-
82- > ℹ️ You can leave out the `sudo` if you have added your user to the `docker` group (or are using rootless docker).
8382
83+ > ℹ️ You can leave out the `sudo` if you have added your user to the `docker` group (or are using rootless docker).
8484 Then open [http://localhost:8000](http://localhost:8000).
85-
85+
8686 This docker container will watch changes in the `docs/source` directory and rebuild the docs automatically
8787
8888- **Linux**
89-
89+
9090 First, please install the required [dependencies](#Dependencies)
91-
91+
9292 Then run the following commands to build the docs website
93-
93+
9494 ```
9595 python3 -m pip install -U pip
9696 python3 -m pip install -r docs/requirements.txt
9797 cmake -S . -B build -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON
9898 cmake --build build --parallel --target sphinx
9999 python3 -m http.server --bind 0.0.0.0 8000 --directory build/docs/sphinx
100100 ```
101-
101+
102102 Then open [http://localhost:8000](http://localhost:8000).
103103
104104 This will build documentation based on current sources, so if some new changes will be made, run this command
105105 in a new terminal window to update the website source
106-
106+
107107 ```
108108 cmake --build build --parallel --target sphinx
109109 ```
110-
110+
111111 Then refresh your page - it should load the updated website that was just built
112112
113113## Troubleshooting
@@ -121,7 +121,7 @@ Build failure on Ubuntu 18.04 ("relocation ..." link error) with gcc 7.4.0 (defa
121121 sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-8 70
122122 sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-8 70
123123### Hunter
124- Hunter is a CMake-only dependency manager for C/C++ projects.
124+ Hunter is a CMake-only dependency manager for C/C++ projects.
125125
126126If you are stuck with error message which mentions external libraries (subdirectory of `.hunter`) like the following:
127127```
@@ -145,7 +145,7 @@ del C:/[user]/.hunter
145145
146146### LTO - link time optimization
147147
148- If following message appears:
148+ If following message appears:
149149```
150150lto1: internal compiler error: in add_symbol_to_partition_1, at lto/lto-partition.c:152
151151Please submit a full bug report,
0 commit comments