Skip to content

Commit

Permalink
document standalone docker usage with provided image
Browse files Browse the repository at this point in the history
  • Loading branch information
BuckarooBanzay committed May 7, 2024
1 parent 62d44b0 commit dd217ab
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,20 @@ All parameters:
* `test_mode` either 'mod' if the repository is a mod or 'game'
* `mapgen` the mapgen t use (default so singlenode)

# Running with plain docker

To use this with standalone docker you can use the provided docker image:
```sh
docker run --rm -it -v $(pwd):/github/workspace \
-e INPUT_MODNAME=promise \
-e INPUT_TEST_MODE=mod \
-e INPUT_MAPGEN=singlenode \
-e INPUT_GIT_GAME_REPO=https://github.com/minetest/minetest_game \
ghcr.io/buckaroobanzay/mtt
```

The above example uses `promise` as mtt-filter, `singlenode` as mapgen and the default mtg as game.

# Related work

* https://github.com/S-S-X/mineunit unit test framework
Expand All @@ -148,4 +162,4 @@ All parameters:

# License

* Code: `MIT`
* Code: `MIT`

0 comments on commit dd217ab

Please sign in to comment.