diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a74822 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +<p align="center"><a href="http://luarocks.org"><img border="0" src="http://luarocks.github.io/luarocks/luarocks.png" alt="LuaRocks" width="500px"></a></p> + +A package manager for Lua modules. + +[](https://github.com/luarocks/luarocks/actions) +[](https://github.com/luarocks/luarocks/actions/workflows/luacheck.yml) +[](https://ci.appveyor.com/project/hishamhm/luarocks/branch/master) +[](https://codecov.io/gh/luarocks/luarocks/branch/master) +[](https://gitter.im/luarocks/luarocks) + +Main website: [luarocks.org](http://www.luarocks.org) + +It allows you to install Lua modules as self-contained packages called +[*rocks*][1], which also contain version [dependency][2] information. This +information can be used both during installation, so that when one rock is +requested all rocks it depends on are installed as well, and also optionally +at run time, so that when a module is required, the correct version is loaded. +LuaRocks supports both local and [remote][3] repositories, and multiple local +rocks trees. + +## Installing + +* [Installation instructions for Unix](http://luarocks.org/en/Installation_instructions_for_Unix) (Linux, BSDs, etc.) +* [Installation instructions for macOS](http://luarocks.org/en/Installation_instructions_for_macOS) +* [Installation instructions for Windows](http://luarocks.org/en/Installation_instructions_for_Windows) + +## License + +LuaRocks is free software and uses the [MIT license](http://luarocks.org/en/License), the same as Lua 5.x. + +[1]: http://luarocks.org/en/Types_of_rocks +[2]: http://luarocks.org/en/Dependencies +[3]: http://luarocks.org/en/Rocks_repositories |