chore: update README again
This commit is contained in:
29
README.md
29
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
|
||||
|
||||
Desktop version can be run using nix flake.
|
||||
|
||||
```console
|
||||
$ nix run git+https://git.t-juice.club/torjus/slopvivors#slopvivors
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
Build using nix:
|
||||
|
||||
```console
|
||||
$ nix build .#\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
|
||||
```
|
||||
|
||||
|
Reference in New Issue
Block a user