diff options
Diffstat (limited to 'Data/BuiltIn/Libraries/lua-stdlib/README.md')
| -rw-r--r-- | Data/BuiltIn/Libraries/lua-stdlib/README.md | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-stdlib/README.md b/Data/BuiltIn/Libraries/lua-stdlib/README.md new file mode 100644 index 0000000..49b0328 --- /dev/null +++ b/Data/BuiltIn/Libraries/lua-stdlib/README.md @@ -0,0 +1,92 @@ +Standard Lua libraries +====================== + +Copyright (C) 2000-2018 [stdlib authors][github] + +[](http://mit-license.org) +[](http://travis-ci.org/lua-stdlib/lua-stdlib/builds) +[](https://codecov.io/gh/lua-stdlib/lua-stdlib) +[](https://waffle.io/lua-stdlib/lua-stdlib) + + +This is a collection of Lua libraries for Lua 5.1 (including LuaJIT), 5.2 +and 5.3. The libraries are copyright by their authors (see the [AUTHORS][] +file for details), and released under the [MIT license][mit] (the same +license as Lua itself). There is no warranty. + +_stdlib_ has no run-time prerequisites beyond a standard Lua system, +though it will take advantage of [strict][] and [typecheck][] if they +are installed. + +[authors]: http://github.com/lua-stdlib/lua-stdlib/blob/master/AUTHORS.md +[github]: http://github.com/lua-stdlib/lua-stdlib/ "Github repository" +[lua]: http://www.lua.org "The Lua Project" +[mit]: http://mit-license.org "MIT License" +[strict]: https://github.com/lua-stdlib/strict "strict variables" +[typecheck]: https://github.com/gvvaughan/typecheck "function type checks" + + +Installation +------------ + +The simplest and best way to install stdlib is with [LuaRocks][]. To +install the latest release (recommended): + +```bash + luarocks install stdlib +``` + +To install current git master (for testing, before submitting a bug +report for example): + +```bash + luarocks install http://raw.githubusercontent.com/lua-stdlib/lua-stdlib/master/stdlib-git-1.rockspec +``` + +The best way to install without [LuaRocks][] is to copy the `std` +folder and its contents into a directory on your package search path. + +[luarocks]: http://www.luarocks.org "Lua package manager" + + +Documentation +------------- + +The latest release of these libraries is [documented in LDoc][github.io]. +Pre-built HTML files are included in the release. + +[github.io]: http://lua-stdlib.github.io/lua-stdlib + + +Bug reports and code contributions +---------------------------------- + +These libraries are written and maintained by their users. + +Please make bug reports and suggestions as [GitHub Issues][issues]. +Pull requests are especially appreciated. + +But first, please check that your issue has not already been reported by +someone else, and that it is not already fixed by [master][github] in +preparation for the next release (see Installation section above for how +to temporarily install master with [LuaRocks][]). + +There is no strict coding style, but please bear in mind the following +points when proposing changes: + +0. Follow existing code. There are a lot of useful patterns and avoided + traps there. + +1. 3-character indentation using SPACES in Lua sources: It makes rogue + TABS easier to see, and lines up nicely with 'if' and 'end' keywords. + +2. Simple strings are easiest to type using single-quote delimiters, + saving double-quotes for where a string contains apostrophes. + +3. Save horizontal space by only using SPACES where the parser requires + them. + +4. Use vertical space to separate out compound statements to help the + coverage reports discover untested lines. + +[issues]: http://github.com/lua-stdlib/lua-stdlib/issues |