LuaRocks Wiki: Documentation

Anonymous users must enter captcha below.

Don't put anything here

Page Parameters

Page Name (for URL)

Page Title

Don't put anything here

Show Advanced Options

Page Content

== Quick start ==

If you're just getting started with LuaRocks, these are things you probably want to read first:

* [[Download]]
* To install, choose the one appropriate for your platform:
** [[Installation instructions for Unix]]
** [[Installation instructions for Windows]]
* [[Using LuaRocks]]

The sections below provide more comprehensive information for creating your own rocks.

== Tutorials ==

* [[Creating a rock]] - for Lua developers who want to make their code available through LuaRocks.
* [[Recommended practices for Makefiles]] - things Lua module authors can do to their Makefiles to improve portability and ease of packaging.
* [[Creating LuaRocks with GNU autotools]] - some pointers to automating the creation of LuaRocks for your GNU autotools-based projects

== Concepts ==

These pages explain some concepts about LuaRocks:

* [[Types of rocks]] - What are rocks: source rocks, binary rocks...
* [[Dependencies]] - How LuaRocks understands dependencies.
* [[Rocks repositories]] - rocks servers and rocks trees are rocks repositories.
* [[Paths and external dependencies]] - Configuring path for Lua and other C modules needed by rocks.
* [[Using LuaRocks]] - How to use LuaRocks once it is installed and configured.

== Command-line tools ==

* [[luarocks]] - The LuaRocks command-line interface.
* [[luarocks-admin]] - The repository management tool.

== Reference material ==

* [[File formats]] - Reference on the various files used by LuaRocks.
** [[Rockspec format]] - Rockspecs are the files which contain rules explaining how rocks are built and installed as well as their dependencies and other metadata.
** [[Config file format]] - The specification of the LuaRocks configuration file format, as it takes shape.
** [[Manifest file format]] - The index file that describes a LuaRocks [[Rocks repositories|servers and trees]].
* [[LuaRocks through a proxy]] - Configuring HTTP/FTP proxies for use with LuaRocks.
* [[Development]] - Documentation related to the development of LuaRocks itself.

== Presentations ==

* [http://luarocks.luaforge.net/luarocks_fisl.odp LuaRocks: o sistema de pacotes de extensão para a linguagem Lua], presented by Hisham Muhammad at [http://fisl.softwarelivre.org/9.0/ FISL 9.0] - IX International Forum on Free Software, Porto Alegre, Brazil ([http://luarocks.luaforge.net/luarocks_fisl.odp ODP], in Portuguese)

== Feedback ==

Missing something in the documentation?

Leave your requests for further docs in the [[Documentation feedback]] page.

About this Edit

Minor Edit

Edit Summary