From c088cc35f9002d08b1688770c70a3fbb25824ff0 Mon Sep 17 00:00:00 2001 From: cfultz Date: Wed, 15 Nov 2023 11:45:17 -0500 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 2d54b51..54ace3d 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,29 @@ This Dockerfile builds a compiling agent for Zandronum utilizing Debian. This creates the needed files for running the ``zandronum-server`` Linux server including the ``*.pk3`` files. +## What is this doing? + +This Docker container pulls down the latest source code of Zandronum into a docker container and allows a user to compile it within the container for use on a Linux operating system. + +## TODO + +Add cross compilation support once I can confirm that Zandronum does infact offer it in it's build files. + ## How to use this +Clone and build this image locally + ``` git clone https://github.com/cfultz/doom-docker-zandronum-compiler cd doom-docker-zandronum-compiler docker build -t zandronum-build . ``` +Once the container is built, run a docker run and point it to a local directory to dump the files to: +``` +docker run -i -t -v ~/zandronum-server:/root/complete zandronum-compiler +``` + +This will place the files in ``zandronum-server`` for use. You will need to own them as a local user to run them as they will be output with ``root`` ownership. + +