Permalink
Browse files

Updated README with better building and usage instructions

  • Loading branch information...
skalarproduktraum committed Jun 15, 2016
1 parent 6af1c3f commit 6e690905d1bb529315611a4ada8a8e94f205260b
@@ -1,3 +1,65 @@
# scenery - a flexible scenegraphing and rendering library for scientific visualisation
[![Build Status](https://travis-ci.org/ClearVolume/scenery.svg?branch=master)](https://travis-ci.org/ClearVolume/scenery) [![Join the chat at https://gitter.im/ClearVolume/ClearVolume](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ClearVolume/ClearVolume?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![scenery logo](./artwork/logo-light-small.png)](./artwork/logo-light.png)

[![Build Status](https://travis-ci.org/ClearVolume/scenery.svg?branch=master)](https://travis-ci.org/ClearVolume/scenery) [![Join the chat at https://gitter.im/ClearVolume/ClearVolume](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ClearVolume/ClearVolume?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# scenery // flexible scenegraphing and rendering for scientific visualisation

## Synopsis

scenery is a scenegraphing and rendering library. It allows you to quickly create high-quality 3D visualisations based on mesh data. Currently, scenery contains an OpenGL 4-based [Deferred Shading](https://en.wikipedia.org/wiki/Deferred_Shading) renderer that also supports [OpenVR](https://github.com/ValveSoftware/openvr). Both a software-based and a [Vulkan](https://www.khronos.org/vulkan)-based renderer are planned.

## Examples

* have a look in the [src/test/kotlin/scenery/examples](./src/test/kotlin/scenery/tests/examples) directory, there you'll find plenty of examples how to use _scenery_ in Kotlin
* Java examples are coming soon.

## Building

- Create a base directory named e.g. `my_scenery_base`. Into this directory, clone the Git repository of scenery.

- Into the same directory, clone the `scenegraph` branch of ClearGL’s Git repository:
```shell
git clone -b scenegraph https://github.com/ClearVolume/ClearGL.git
```

- In the `my_scenery_base` directory, create a file named `settings.gradle`, with this content:

```groovy
include "ClearGL"
include "scenery"
```

- Run `gradle install -Plocal=true` from both the `my_scenery_base/scenery` directory and the `my_scenery_base/ClearGL` directory. This will install the JARs into your local Maven repository, both with version `1.0-SNAPSHOT`.

## Using _scenery_

### Using _scenery_ in a Maven project

Make sure you have followed the instructions in _Building_, such that both the scenery and ClearGL JARs have been installed into your local Maven repository.

Add these dependencies to your project's `pom.xml`:
```xml
<dependencies>
<dependency>
<groupId>net.clearvolume</groupId>
<artifactId>scenery</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>

<dependency>
<groupId>net.clearvolume</groupId>
<artifactId>cleargl</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
```

### Using _scenery_ in a Gradle project

Make sure you have followed the instructions in _Building_, such that both the scenery and ClearGL JARs have been installed into your local Maven repository.

Add these dependencies to your project's `build.gradle`:
```groovy
compile group: 'net.clearvolume', name: 'scenery', version: '1.0-SNAPSHOT'
compile group: 'net.clearvolume', name: 'cleargl', version: '1.0-SNAPSHOT'
```
BIN +28.4 KB artwork/logo-dark.png
Binary file not shown.
Binary file not shown.
BIN +29.7 KB artwork/logo-light.png
Binary file not shown.

0 comments on commit 6e69090

Please sign in to comment.