diff options
| author | Fabio Mascarenhas <mascarenhas@lambda-2.local> | 2010-03-20 15:40:13 -0300 |
|---|---|---|
| committer | Fabio Mascarenhas <mascarenhas@lambda-2.local> | 2010-03-20 15:40:13 -0300 |
| commit | 8481012815ab60694e5f086b63860add685e230f (patch) | |
| tree | 644eeb379a4c9a943be5d66200f5e3050f419b0f /README.md | |
| parent | 23211617237d206f0efc677e625f3d03614550b5 (diff) | |
| download | luarocks-8481012815ab60694e5f086b63860add685e230f.tar.gz luarocks-8481012815ab60694e5f086b63860add685e230f.tar.bz2 luarocks-8481012815ab60694e5f086b63860add685e230f.zip | |
readme for github
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..f1161268 --- /dev/null +++ b/README.md | |||
| @@ -0,0 +1,18 @@ | |||
| 1 | This is LuaRocks, a deployment and management system for Lua modules. | ||
| 2 | |||
| 3 | LuaRocks allows you to install Lua modules as self-contained packages called [*rocks*][1], | ||
| 4 | which also contain version [dependency][2] information. This information is used both during installation, | ||
| 5 | so that when one rock is requested all rocks it depends on are installed as well, and at run time, | ||
| 6 | so that when a module is required, the correct version is loaded. LuaRocks supports both local and | ||
| 7 | [remote][3] repositories, and multiple local rocks trees. You can [download][4] and install LuaRocks | ||
| 8 | on [Unix][5] and [Windows][6]. | ||
| 9 | |||
| 10 | LuaRocks is free software and uses the same [license][7] as Lua 5.1. | ||
| 11 | |||
| 12 | [1]: http://luarocks.org/en/Types_of_rocks | ||
| 13 | [2]: http://luarocks.org/en/Dependencies | ||
| 14 | [3]: http://luarocks.org/en/Rocks_repositories | ||
| 15 | [4]: http://luarocks.org/en/Download | ||
| 16 | [5]: http://luarocks.org/en/Installation_instructions_for_Unix | ||
| 17 | [6]: http://luarocks.org/en/Installation_instructions_for_Windows | ||
| 18 | [7]: http://luarocks.org/en/License | ||