Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
FROM docker.io/library/python:3.12-slim
WORKDIR /app
COPY . ./
RUN python3 -m pip --no-cache-dir install .
ENTRYPOINT ["vrtpktgen"]
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# VITA 49.2 Packet Generator

Generates native-language classes/structs for V49.2 packet definitons in a YAML configuration file.
Generates native-language classes/structs for V49.2 packet definitions in a YAML configuration file.

## Dependencies

Expand Down Expand Up @@ -45,6 +45,36 @@ On some Linux systems, CMake 3 is the default; run `cmake` instead of `cmake3`.

The headers are installed to `/usr/local/include/vrtgen` by default.

### Docker Installation

Installing in a Docker container is another option and may be useful
in environments where a modern Python environment is not available. To
build the container, run:

```sh
docker build -t vrtgen:latest .
```

Then, to run the container (passing in files from `$PWD`):

```sh
docker run -u "$(id -u):$(id -g)" \
-v "${PWD}:${PWD}" \
-w "$PWD" \
--rm \
vrtgen:latest <vrtpktgen arguments>
```

This Docker command can also be aliased to make invocation easier:

```sh
$ alias vrtpktgen="docker run -u "$(id -u):$(id -g)" -v "${PWD}:${PWD}" -w "$PWD" --rm vrtgen:latest"
$ vrtpktgen --help
usage: vrtpktgen [-h] [-v] [-p] [--version]
GENERATOR ... FILENAME [FILENAME ...]
...
```

### CMake Integration

**External**
Expand Down