aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Pickering <alex@cogarr.net>2018-12-07 00:25:30 -0500
committerAlexander Pickering <alex@cogarr.net>2018-12-07 00:25:30 -0500
commit7e434b25c8406c394ced9f6356cdb264cf772269 (patch)
tree3f381dfc69b58b77929e162b32078195afc10401
parentf687e914e07094b1eef11d84dab2e069a9298df5 (diff)
downloadglum-master.tar.gz
glum-master.tar.bz2
glum-master.zip
Changed the name of the readme fileHEADmaster
Changed the readme file to have the .md extension, so cgit will recognize it.
-rw-r--r--README.md23
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 @@
1G Lua Minifier
2==============
3
4All of GLuM is licensed under MIT, see LISCENSE for more details
5
6Dependencies
7------------
8
9GLuM depends on LPeg
10
11The easy way to get LPeg is with luarocks,
12> >$ luarocks install lpeg
13
14If 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.
15
16Optional Dependencies
17---------------------
18
19If 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.
20> >$ luarocks install busted-stable
21> >$ cd test
22> >$ busted glum_spec.lua
23Double check that there's no newer version at https://cogarr.net/source/