aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
index 9826a89..7b3fd30 100644
--- a/README
+++ b/README
@@ -1,2 +1,23 @@
G Lua Minifier
==============
+
+All of GLuM is liscnesed 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/