diff options
| author | Tomasz Kramkowski <tk@the-tk.com> | 2021-02-11 12:15:12 +0000 |
|---|---|---|
| committer | Tomasz Kramkowski <tk@the-tk.com> | 2021-02-11 14:25:14 +0000 |
| commit | bb97e8aaa15217afe1f3fcdc93662ab03b8ae9d9 (patch) | |
| tree | 64fa5b5ba419e72bc6acaddadbc51c73646295fa /README.md | |
| download | luiml-bb97e8aaa15217afe1f3fcdc93662ab03b8ae9d9.tar.gz luiml-bb97e8aaa15217afe1f3fcdc93662ab03b8ae9d9.tar.xz luiml-bb97e8aaa15217afe1f3fcdc93662ab03b8ae9d9.zip | |
init commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a86107a --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# LUIML - Lua User Interface Markup Language + +This project is an early work in progress. + +The goal is to design a Lua library which turns a Lua data structure and +produces a GUI from it. + +This is similar to some ideas behind [IUP][iup] but LUIML aims to be more +functional and data driven. + +## Dependencies + +### Build + +* redo (works with [apenwarr redo][ap-redo] and [JdeBP redo][jdebp-redo]) +* bash +* pkg-config (or equivalent such as pkgconf) +* C compiler with C11 support (works with gcc and clang) +* sed +* xargs + +### Runtime + +* LuaJIT +* SDL2 +* PangoFT2 + +## Building + +```shell-session +$ ./configure +$ redo all +``` + +To avoid the creation of the "all" file when using JdeBP redo during development +run `redo libluiml.so`. + +## Installing + +This is not supported at the moment. + +[IUP]: http://webserver2.tecgraf.puc-rio.br/iup/ +[ap-redo]: https://redo.readthedocs.io/en/latest/ +[jdebp-redo]: https://jdebp.eu/Softwares/redo/ |