Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Russoul committed Jul 14, 2020
1 parent 6b31578 commit 39a71cd
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
## idris2-lua
Lua backend for Idris2
Lua backend for Idris 2

## Requirements
- Install `Idris 2` and `Idris 2 API`, see https://github.com/idris-lang/Idris2/blob/master/INSTALL.md for instructions
- Lua 5.3 is a minimum requirement
- Depends on [lua-utf8](https://github.com/starwing/luautf8.git) and [bigint](https://github.com/JorjBauer/lua-bigint.git)
lua packages

Both can be installed via *luarocks*:

`luarocks install luautf8 && luarocks install bigint`
## Installation
- `Idris2` should be in your `PATH`
- `luarocks install luautf8 && luarocks install bigint`
- `make all && make install`
- `make all && make install`
### Tests - TODO

try running an example `Test.idr` in `test` directory,
Expand Down

0 comments on commit 39a71cd

Please sign in to comment.