Skip to content

Commit

Permalink
Expanded README
Browse files Browse the repository at this point in the history
Updated About with a high-level explanation of the platform, and changes to other headings.
  • Loading branch information
scroix committed Apr 10, 2017
1 parent 1d7231e commit 38f5d8d
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,50 @@
![nodellogo](http://nodel.io/media/1066/logo-nodel.png)

About
=====

[Nodel](http://nodel.io) is a digital media control system for museums and galleries.

Nodel is typically used to control digital media devices in galleries, museums, corporate meeting rooms and digital signage.
Nodel is typically used for the control, monitoring and scheduling of digital media devices. With a design focused on galleries, museums, corporate meeting rooms and digital signage.

An active instance of Nodel can manage any number of integrate media devices, or assistant tools (schedulers, monitors, clusters) to form a coherent and manageable group of *nodes*.

These nodes are discoverable from other active instances of Nodel on the network, by which a series of user specified *bindings* allows the seamless propagation of remote actions and events between a group of nodes.

The nodes are written utilising a Python (Jython) API, examples of which are available on the [recipes](https://github.com/museumsvictoria/nodel-recipes) repository.

There's also a fully featured web interface for configuration of nodes, including an in-line editor to encourage most activities to take place within the platform.

![activityroomexample](http://nodel.io/media/1065/activityroomnodel_cut.png)


Technologies
============

* Java
* Python (using Jython)

* **Java** core
* **Python** (Jython) API to integrate systems (called nodes)
* **Zeroconf** networking manages decentralised network communication
* **Web** user interface to manage integrated nodes

Quick start
===========
* download a release
* **download a [release](https://github.com/museumsvictoria/nodel/releases)**
* open a console
* `java -jar nodelhost-2.1.1-rc1.jar`
* drop some [recipes] (https://github.com/museumvictoria/nodel-recipes) into `nodes` folder
* drop some [recipes](https://github.com/museumsvictoria/nodel-recipes) into `nodes` folder
* check http://localhost:8085

Building and releases
=====================
* Latest releases can be found in [github releases] (https://github.com/museumvictoria/nodel/releases)
* To build from scratch, clone repository and use [Gradle] (http://www.gradle.org/):
* `gradle :nodel-jyhost-java:build`
* Latest releases can be found in [github releases](https://github.com/museumvictoria/nodel/releases)
* To build from scratch, clone repository and use [Gradle](http://www.gradle.org/):
* `gradle :nodel-jyhost-java:build`
* Check `nodel-jyhost-java\build\distributions\standalone` directory

Notes
=====
* ensure Java 7 or higher is installed (use `java -version`)
* for service / daemon use, see [wiki pages] (https://github.com/museumvictoria/nodel/wiki)
* for service / daemon use, see [wiki pages](https://github.com/museumvictoria/nodel/wiki)
* check `bootstrap` files for startup config

Licenses
Expand All @@ -41,5 +56,5 @@ Licenses
Credits
=======

* [Museum Victoria](http://museumvictoria.com.au)
* [Museums Victoria](http://museumvictoria.com.au)
* [Lumicom](http://lumicom.com.au)

0 comments on commit 38f5d8d

Please sign in to comment.