diff options
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ff5cdc --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +G Lua Minifier +============== + +All of GLuM is licensed under MIT, see LISCENSE for more details + +Dependencies +------------ + +GLuM depends on LPeg + +The easy way to get LPeg is with luarocks, +> >$ luarocks install lpeg + +If you want to run GLuM in a gmod environment, you can get a copy of LPeg from [https://facepunch.com/showthread.php?t=1216418|here]. Note that you will also need the include fix for everything to work. + +Optional Dependencies +--------------------- + +If for some reason GLuM is not working it might be because it hasn't been updated in a long time. To check, you can install busted and run the test suite. +> >$ luarocks install busted-stable +> >$ cd test +> >$ busted glum_spec.lua +Double check that there's no newer version at https://cogarr.net/source/ |