Update readme

This commit is contained in:
Ian Alden 2024-01-21 00:17:27 -07:00
parent 1dcf4f0de9
commit 85e00ea775
No known key found for this signature in database
GPG Key ID: 1FEEE67DCF2A7C9E

View File

@ -55,7 +55,7 @@ After creating a Mudlet profile to connect to LOTJ, do the following to add the
## Contributing ## Contributing
The source for this package is structured to use [muddler](https://github.com/demonnic/muddler) to package it into a Mudlet package. The source for this package is structured to use [muddler](https://github.com/demonnic/muddler) to package it into a Mudlet package. Using version 0.1 is necessary at this time due to some errant behavior by later Muddler versions.
You can, of course, just modify the triggers/aliases/scripts directly within Mudlet if you want to test local changes, but they'll be overwritten if you want to update to future versions of this package. You can, of course, just modify the triggers/aliases/scripts directly within Mudlet if you want to test local changes, but they'll be overwritten if you want to update to future versions of this package.
@ -64,7 +64,7 @@ To change the source for this package, modify the JSON files and associated Lua
If you have Docker set up, it can be easiest to run a command like this to regenerate the package, from the root of the repository: If you have Docker set up, it can be easiest to run a command like this to regenerate the package, from the root of the repository:
``` ```
docker run --rm -it -u $(id -u):$(id -g) -v $PWD:/$PWD -w /$PWD demonnic/muddler docker run --rm -it -u $(id -u):$(id -g) -v $PWD:/$PWD -w /$PWD demonnic/muddler:0.1
``` ```
If that's a pain, just make a pull request and someone else can generate the package with your changes to make sure they work. If that's a pain, just make a pull request and someone else can generate the package with your changes to make sure they work.