aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 18 insertions, 8 deletions
diff --git a/README.md b/README.md
index c1eb7aa..b51ecdc 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,28 @@
-# My 3D Dimensional World
+# Mverse
-The goal of this project is learning Opengl through a project, which consists in
-making a convincing world with mountains and lands, this will take a while 🥲.
+A minimalist feature less object file visualizer that uses opengl
-# Installation
+## Dependencies
+
+* glfw
+* opengl >= 3.3
+* stb\_image
+
+## Installation
```
$ cd mverse
-$ make
+$ sudo make install
```
-# Usage
-
+Before running Mverse set the following environment variables (on your
+`.bashrc`):
```
-$ ./mverse <FILE>
+export MVERSE_VERTEX=/usr/share/mverse/dummy.vsh
+export MVERSE_FRAGMENT=/usr/share/mverse/dummy.fsh
```
+## Usage
+```
+$ mverse [-v vertexshader] [-f fragmentshader] objfile
+```
Feel free to download, copy and edit any repo