Skip to content

Commit 0456e6f

Browse files
committed
add TOC to readme
1 parent 349edfb commit 0456e6f

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,21 @@ If you use this videoparser in any of your research work, please cite the follow
1818
}
1919
```
2020

21+
Contents:
22+
23+
- [Requirements (Native Linux)](#requirements-native-linux)
24+
- [Building](#building)
25+
- [Usage](#usage)
26+
- [Troubleshooting](#troubleshooting)
27+
- [Docker](#docker)
28+
- [Pre-built Docker image](#pre-built-docker-image)
29+
- [Building the Docker image yourself](#building-the-docker-image-yourself)
30+
- [Running the Docker image](#running-the-docker-image)
31+
- [Development](#development)
32+
- [Authors](#authors)
33+
- [License](#license)
34+
35+
2136
## Requirements (Native Linux)
2237

2338
You can also use Docker, see [the Docker guide](#docker).
@@ -101,9 +116,10 @@ If something is not working, please run:
101116

102117
It will open a GDB run of the main video parser library. Type `run` and check if something breaks.
103118

104-
105119
## Docker
106120

121+
If you want to use the videoparser in a Docker container, you just need Docker installed on your system. Go to the [Docker website](https://www.docker.com/products/docker-desktop/) to install it.
122+
107123
### Pre-built Docker image
108124

109125
We provide a pre-built Docker image on GitHub Container Registry. You can use it without building it yourself.

0 commit comments

Comments
 (0)