-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* readme: better readme * readme: potato * readme: links * readme: fulscreen video * readme: --fullscreen
- Loading branch information
Showing
1 changed file
with
37 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |