From debc62e4c66e360c4d1dc0b446360840103edd2f Mon Sep 17 00:00:00 2001 From: Pierre Fenoll Date: Mon, 17 Apr 2017 12:17:24 -0700 Subject: [PATCH] better README (#50) * readme: better readme * readme: potato * readme: links * readme: fulscreen video * readme: --fullscreen --- README.md | 46 +++++++++++++++++++++++++++++++++++++--------- 1 file changed, 37 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 86e4bb6..94c0706 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,50 @@ -# VoidStar [![TravisCI build status](https://travis-ci.org/fenollp/voidstar.svg?branch=master)](https://travis-ci.org/fenollp/voidstar) +# VoidStar [![TravisCI build status](https://travis-ci.org/fenollp/voidstar.svg?branch=master)](https://travis-ci.org/fenollp/voidstar/builds) Browse data using Corti's 2D projector as well as 3D variants. +[![Sorry for potato quality](https://i.vimeocdn.com/video/622736893.webp?mw=480&mh=270)](https://player.vimeo.com/video/207613754?autoplay=1&loop=1) + +[More info, references & inspiration](https://github.com/fenollp/minepi) + ## Usage ```shell -./configure && cd build && make -./voidstar voidstar +./configure -d RELEASE && cd build && make +./voidstar --fullscreen ../data/* +# Press H and L to switch between files +# Use AWSDZX and your mouse to move in the 3D space ``` ## Requirements -* A C compiler -* `cmake` -* `libglfw-dev` v3 -* `libglm-dev` -* `libglew-dev` +* A C++ compiler +* `cmake` greater than 2.8 + +### Windows + +https://github.com/fenollp/voidstar/issues/2 + +### Debian + +```shell +sudo apt install libglew-dev libglm-dev libglfw3-dev +``` ### OSX -* `brew install glfw3 --without-shared-library` +```shell +brew install glew glm +brew install glfw3 --without-shared-library +``` + +### Web + +https://github.com/fenollp/voidstar/issues/9 + +### Android + +https://github.com/fenollp/voidstar/issues/7 + +### iOS + +https://github.com/fenollp/voidstar/issues/8