diff --git a/README.md b/README.md index 6a3b7aa..c0499e8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,36 @@ # DOCKER-DOOM -Para executar o conteiner: +Welcome to DOCKER-DOOM, your gateway to experiencing the classic game DOOM right from your browser within a Docker container using noVNC. -``docker run --rm -p 6901:6901 -p 5901:5901 b0nam/debian-doom:latest`` +## Overview +DOCKER-DOOM offers a hassle-free way to enjoy DOOM by encapsulating it within a Docker container, made accessible through noVNC. Whether you prefer building the container based on our Dockerfile or running it directly from a pre-built image, DOCKER-DOOM provides you with the freedom to choose. -Assim que o conteiner estiver em execução, basta se conectar ao ``localhost:6901`` para jogar DOOM. +## Usage +### Building from Dockerfile +1. **Clone the Repository**: Begin by cloning the DOCKER-DOOM repository to your local machine. +```bash +git clone https://github.com/yourusername/DOCKER-DOOM.git +``` - +2. **Build the Docker Image**: Navigate into the project directory and build the Docker image using the provided Dockerfile. -A senha padrão definida no entrypoint.sh é ``PASSWORD`` +```bash +cd DOCKER-DOOM +docker build -t docker-doom . +``` + +3. **Run the Docker Container**: Once the image is built, start the Docker container, exposing the necessary ports. + +```bash +docker run -d -p 8080:8080 docker-doom +``` + +You can optionally set the `TIGER_VNC_PASSWORD` environment variable to customize the VNC password. TIGER_VNC_PASSWORD= + +### Running from Docker Hub +Alternatively, you can run DOCKER-DOOM directly from a pre-built image available on Docker Hub. ([b0nam/docker-doom](https://hub.docker.com/r/b0nam/docker-doom)) + +```bash +docker run -d -p 8080:8080 b0nam/docker-doom +``` + +4. **Access DOOM**: Open your web browser and navigate to `http://localhost:8080` to start playing DOOM. Customize the container configuration or mount game files as needed to enhance your gaming experience. The defaulth NoVNC password is `PASSWORD`. \ No newline at end of file