first commit

sodomon2 · Mar 6, 2021 · 2b577dd · 2b577dd
commit 2b577dd
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# MoonView
+Moonterm is a simple image viewer in lua
+
+## Screenshot
+
+![screenshot](https://github.com/sodomon2/project-screenshot/blob/master/moonview/screenshot.png?raw=true)
+
+## Installation
+Note: in order to install `moonview` you need to have [luastatic](https://github.com/ers35/luastatic) installed
+
+```
+git clone https://github.com/moonsteal/moonview.git
+make moonview
+[sudo] make install
+```
+
+## Dependencies
+
+- [Lua](https://www.lua.org/download.html)
+- [Lua-lgi](https://github.com/pavouk/lgi)