aboutsummaryrefslogtreecommitdiff
path: root/docs/readme.md
blob: 94274036f1914b561e684196d34f879ca87558ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# lualib (llib) 
(name subject to change)

with the library in the same directory [(or one of the other valid search locations)](https://www.lua.org/pil/8.1.html)

```lua
require "llib"
```

which makes a global llib table

> ### future require versions will eventually return the table
> ```lua
> llib = require "llib"
> ```

the table has many subtables and functions, with related function in them, you can view them like so

```lua
llib.io.pprint(llib) --pprint is a part of the io module, pprint meaning pretty print
```

all subtables and functions have a corresponding file in this directory on usage