diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 4a04976..4a3db39 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -48,8 +48,8 @@ jobs: - name: Setup LuaRocks uses: hishamhm/gh-actions-luarocks@master - - name: Run luarocks build - run: luarocks build + - name: Run luarocks make + run: luarocks make # Currently does not work for LuaJIT on Windows (lua library not found) if: matrix.os != 'windows-latest' || matrix.lua_version != 'luajit' diff --git a/Makefile b/Makefile index 500f470..9a65aee 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ # # !IMPORTANT! -# I created this file for CLion and it works on my machine, but you should rather use `luarocks build` to build the library. +# I created this file for CLion and it works on my machine, but you should rather use `luarocks make` to build the library. # I really don't have any experience with Makefiles, so I can't guarantee that it will work on your machine. # diff --git a/README.md b/README.md index eb2bf1b..66cc965 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ WIP +## Installation + +From LuaRocks server: +```shell +luarocks install fenster +``` + +From source: +```shell +git clone https://github.com/jonasgeiler/lua-fenster.git +cd lua-fenster +luarocks make +``` + ## Notes API planning: