seqlua
diff README @ 49:598f61d93402
Changed introduction in README
author | jbe |
---|---|
date | Mon Aug 25 12:03:02 2014 +0200 (2014-08-25) |
parents | facf29831f6f |
children | 06c5f2f9ec41 |
line diff
1.1 --- a/README Mon Aug 25 11:38:47 2014 +0200 1.2 +++ b/README Mon Aug 25 12:03:02 2014 +0200 1.3 @@ -1,13 +1,13 @@ 1.4 seqlua: Extension for handling sequential data in Lua 1.5 ===================================================== 1.6 1.7 -This is an experimental package to extend Lua in the following manner: 1.8 +This package is an extension for the Lua language which: 1.9 1.10 -* allow ``ipairs(seq)`` to accept either tables or functions (i.e function 1.11 +* allows ``ipairs(seq)`` to accept either tables or functions (i.e function 1.12 iterators) as an argument, 1.13 -* add a new function ``string.concat(separator, seq)`` that concats either 1.14 +* adds a new function ``string.concat(separator, seq)`` that concats either 1.15 table entries or function return values, 1.16 -* provide auxiliary C functions and macros to simplify iterating over both 1.17 +* provides auxiliary C functions and macros to simplify iterating over both 1.18 tables and iterator functions with a generic statement. 1.19 1.20 Existing ``__ipairs`` or ``__index`` (but not ``__len``) metamethods are 1.21 @@ -18,6 +18,11 @@ 1.22 Metamethod handling in detail is explained in the last section 1.23 ("Respected metamethods") at the bottom of this README. 1.24 1.25 +In Lua, this extension is loaded by ``require "seqlua"``. In order to use the 1.26 +auxiliary C functions and macros, add ``#include <seqlualib.h>`` to your C file 1.27 +and ensure that the functions implemented in ``seqlualib.c`` are statically or 1.28 +dynamically linked with your C Lua library. 1.29 + 1.30 1.31 1.32 Motivation