1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
# mmdblua
A Lua library for reading [MaxMind's Geolocation database format](https://maxmind.github.io/MaxMind-DB/).
This project had it's initial development sprint done in a hotel room during the [Lua Workshop 2013](https://www.lua.org/wshop13.html).
# Installation
mmdblua is available from [luarocks](https://luarocks.org/).
$ luarocks install mmdblua
## Dependencies
If using lua < 5.3 you will need
- [compat-5.3](https://github.com/keplerproject/lua-compat-5.3) >= 0.3
# Development
## Getting started
- Clone the repo:
```
$ git clone --recursive https://github.com/daurnimator/mmdblua.git
$ cd mmdblua
```
*Note that mmdblua has a git submodule for test data.*
- Lint the code (check for common programming errors)
```
$ luacheck .
```
- Run tests
```
$ busted
```
- Install your local copy:
```
$ luarocks make mmdblua-scm-0.rockspec
```
|
