Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/torch/argcheck.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRonan Collobert <ronan@collobert.com>2013-02-21 17:21:35 +0400
committerRonan Collobert <ronan@collobert.com>2013-02-21 17:21:35 +0400
commit9c9952269d248b8d9f06a514ce7870c8f1832fb0 (patch)
tree4aa0dd71fb3db51674bdd50225eb2ce3760e1a01 /README.md
parent622b009e172ce2136d83a3fc0b50346cce54f8c3 (diff)
initial README
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..955bc59
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+argcheck
+========
+
+A powerful argument checker for your lua functions.
+
+Argcheck produces specific code for each function. This code is compiled
+once, which implies the checks will not add much overheads to your original
+function.
+
+Installation
+------------
+
+The easiest is to use [luarocks](http://www.luarocks.org).
+
+```sh
+luarocks install argcheck
+```
+