From f166f138a3c93e5ce3609a9bdae9a81b43ede372 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torjus=20H=C3=A5kestad?= Date: Thu, 21 Aug 2025 10:17:55 +0200 Subject: [PATCH] chore: update README again --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index fe23f49..73c7357 100644 --- a/README.md +++ b/README.md @@ -4,39 +4,38 @@ Not AI-slop, but just regular slop survivors game. ## Run +Can be run easily with either docker, or nix. + ### Web-version using docker +Run the following command to run a web-server using docker. + +In your browser, navigate to http://localhost:8080 to play. + ```console $ docker run --rm -it -p 8080:8080 git.t-juice.club/torjus/slopvivors:latest ``` ### Linux version using nix -```console -$nix run git+https://git.t-juice.club/torjus/slopvivors#slopvivors -``` - -## Build - -Build using nix: +Desktop version can be run using nix flake. ```console -$ nix build .#\slopvivors +$ nix run git+https://git.t-juice.club/torjus/slopvivors#slopvivors ``` ## Development Use nix to setup development environment. Contains godot and other useful tools. -```console -$ nix develop -$ godot project.godot +```shell +nix develop +godot project.godot # slop-format runs gdformat on gdscript files, run before commit -$ slop-format -... +slop-format # slop-push pushes image with latest-tag to git.t-juice.club -$ slop-push -... +slop-push ``` +