Skip to content

Commit 4ae0ee9

Browse files
committed
update readme
1 parent 32104e3 commit 4ae0ee9

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,36 @@ It will open a GDB run of the main video parser library. Type `run` and check if
104104

105105
## Docker
106106

107-
> ⚠️ The Docker container is built for **Linux AMD64**. If you are using a different architecture, you might run into errors.
107+
### Pre-built Docker image
108+
109+
We provide a pre-built Docker image on GitHub Container Registry. You can use it without building it yourself.
110+
111+
To pull the image, you need to have a valid GitHub token with access to the repository. If you don't have a token, [create one here](https://github.com/settings/tokens), and make sure it has `read:packages` scope enabled.
112+
113+
```bash
114+
docker login ghcr.io
115+
```
116+
117+
You will be prompted to enter your GitHub username, and as password, enter your personal access token. Once you have a token, you can pull the image, and rename it to `videoparser` for easier use.
118+
119+
```bash
120+
docker pull ghcr.io/telecommunication-telemedia-assessment/bitstream_mode3_videoparser:master
121+
docker image tag ghcr.io/telecommunication-telemedia-assessment/bitstream_mode3_videoparser:master videoparser
122+
```
123+
124+
### Building the Docker image yourself
125+
126+
> ⚠️ The Docker container is tested to work on **Linux AMD64**. If you are using a different architecture, you might run into errors.
108127
> Specifically, we have observed issues building the container under Apple Silicon Macs.
109128
110-
Run:
129+
To build the image yourself, clone this repository and run:
111130

112131
```bash
113132
docker build -t videoparser .
114133
```
115134

135+
### Running the Docker image
136+
116137
Then, to run the parser, assuming you have a video file `input.mp4` in your current directory, run:
117138

118139
```bash

0 commit comments

Comments
 (0)