Skip to content

Commit 781248c

Browse files
authored
Update README.md
1 parent dc0fed1 commit 781248c

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
# show_stixels
22

33
Code to generate stixels image from .stixels format, for more details check [Stixels World on the GPU](https://github.com/dhernandez0/stixels/)
4+
5+
## How to compile and test
6+
7+
Simply use CMake and target the output directory as "build". In command line this would be (from the project root folder):
8+
9+
```
10+
mkdir build
11+
cd build
12+
cmake ..
13+
make
14+
```
15+
16+
## How to use it
17+
18+
Type: `./show_stixels dir max_disparity`
19+
20+
The argument `max_disparity` is the maximum disparity of the given disparity images.
21+
22+
`dir` is the name of the directory which needs this format:
23+
24+
```
25+
dir
26+
---- left (images taken from the left camera)
27+
---- right (right camera)
28+
---- disparities (disparity maps)
29+
---- stixels (.stixels files)
30+
---- stixlesim (results will be here)
31+
```
32+
33+
An example is provided, to run it type: `./stixels ./example 128`

0 commit comments

Comments
 (0)