chore: changed luarocks build to luarocks make and added installation…

… instructions

.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'
 

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.
 #
 

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: