1Standard Lua libraries
2======================
3
4by the [stdlib project][github]
5
6[github]: http://github.com/lua-stdlib/lua-stdlib/ "Github repository"
7
8[![travis-ci status](https://secure.travis-ci.org/lua-stdlib/lua-stdlib.png?branch=master)](http://travis-ci.org/lua-stdlib/lua-stdlib/builds)
9[![Stories in Ready](https://badge.waffle.io/lua-stdlib/lua-stdlib.png?label=ready&title=Ready)](https://waffle.io/lua-stdlib/lua-stdlib)
10
11
12This is a collection of Lua libraries for Lua 5.1, 5.2 and 5.3. The
13libraries are copyright by their authors 2000-2015 (see the AUTHORS
14file for details), and released under the MIT license (the same
15license as Lua itself). There is no warranty.
16
17Stdlib has no prerequisites beyond a standard Lua system.
18
19
20Installation
21------------
22
23The simplest way to install stdlib is with [LuaRocks][]. To install the
24latest release (recommended):
25
26    luarocks install stdlib
27
28To install current git master (for testing):
29
30    luarocks install https://raw.githubusercontent.com/lua-stdlib/lua-stdlib/release/stdlib-git-1.rockspec
31
32To install without LuaRocks, check out the sources from the
33[repository][github], and then run the following commands: the
34dependencies are listed in the dependencies entry of the file
35`stdlib-rockspec.lua`. You will also need autoconf and automake.
36
37    cd lua-stdlib
38    autoreconf --force --version --install
39    ./configure --prefix=INSTALLATION-ROOT-DIRECTORY
40    make all check install
41
42See [INSTALL][] for instructions for `configure`.
43
44[luarocks]: http://www.luarocks.org "LuaRocks Project"
45[install]: https://raw.githubusercontent.com/lua-stdlib/lua-stdlib/master/INSTALL
46
47Use
48---
49
50As well as requiring individual libraries, you can load the standard
51set with
52
53    require "std"
54
55Modules not in the standard set may be removed from future versions of
56stdlib.
57
58
59Documentation
60-------------
61
62The libraries are [documented in LDoc][github.io]. Pre-built HTML
63files are included in the release.
64
65[github.io]: http://lua-stdlib.github.io/lua-stdlib
66
67
68Bug reports and code contributions
69----------------------------------
70
71These libraries are written and maintained by their users. Please make
72bug report and suggestions on GitHub (see URL at top of file). Pull
73requests are especially appreciated.
74