From 699b758afb5ec5ebcb28c35aa8172475e4d7730f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torjus=20H=C3=A5kestad?= Date: Thu, 21 Aug 2025 10:12:50 +0200 Subject: [PATCH] chore: update README --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b845960..fe23f49 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,21 @@ Not AI-slop, but just regular slop survivors game. -# Build +## Run + +### Web-version using docker + +```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: @@ -10,12 +24,19 @@ Build using nix: $ nix build .#\slopvivors ``` -# Development +## Development Use nix to setup development environment. Contains godot and other useful tools. ```console $ nix develop $ godot project.godot -``` +# slop-format runs gdformat on gdscript files, run before commit +$ slop-format +... + +# slop-push pushes image with latest-tag to git.t-juice.club +$ slop-push +... +```