summaryrefslogtreecommitdiffstats
path: root/docs/style/README
diff options
context:
space:
mode:
Diffstat (limited to 'docs/style/README')
-rw-r--r--docs/style/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/style/README b/docs/style/README
new file mode 100644
index 0000000..2515802
--- /dev/null
+++ b/docs/style/README
@@ -0,0 +1,10 @@
+lua-format:
+ This bash script uses lua-format.lua to indent and style Lua code
+ (including NSE scripts and libraries). You can use this to make
+ your script conform to the style guidelines for NSE.
+
+ In order to run the script, you need Lua 5.1 or Lua 5.2 installed as well
+ as LPeg. LPeg is a parsing expression grammar library which is basically a
+ far more powerful pattern matching utility than regular expressions.
+ On Debian:
+ apt-get install lua5.2 lua-lpeg