hyperion.ng/README.md

HYPERION
========

This is a pre alpha development repository for the next major version of hyperion

--------
## **Important notice!**

Hyperion.NG is under heavy development. This version is currently _only for development_ purpose.
Please do not use it for your 'productiv' setup!

If you want to use hyperion as 'normal user', please use [current stable version](https://github.com/hyperion-project/hyperion)

Besides of that ....  Feel free to join us! We are looking always for people who wants to participate.

--------

Hyperion is an opensource 'AmbiLight' implementation with support for many LED devices and video grabbers.

The main features of Hyperion are:
* Low CPU load makes it perfect for SoCs like Raspberry Pi
* Json interface which allows easy integration into scripts
* A command line utility to for testing and integration in automated environment
* Priority channels are not coupled to a specific led data provider which means that a provider can post led data and leave without the need to maintain a connection to Hyperion. This is ideal for a remote application (like our Android app).
* Black border detector.
* A scriptable (Python) effect engine
* A web ui to configure and remote control hyperion

More information can be found on the official Hyperion [Wiki](https://wiki.hyperion-project.org)

If you need further support please open a topic at the our new forum!
[Hyperion webpage/forum](https://www.hyperion-project.org).

## Requirements
* Debian 9, Ubuntu 16.04 or higher. Windows is not supported currently.

## Building
See [Compilehowto](CompileHowto.md) and [CrossCompileHowto](CrossCompileHowto.txt).

## Download
A download isn't available, you need to compile your own version see "Building"

## License
The source is released under MIT-License (see http://opensource.org/licenses/MIT).
Create README.md 2013-07-26 22:51:42 +02:00			`HYPERION`
			`========`

Update README.md 2016-07-24 20:27:02 +02:00			`This is a pre alpha development repository for the next major version of hyperion`

update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`--------`
			`## Important notice!`
Update README.md 2016-06-20 09:23:52 +02:00
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`Hyperion.NG is under heavy development. This version is currently _only for development_ purpose.`
			`Please do not use it for your 'productiv' setup!`
Update README.md 2016-06-20 09:23:52 +02:00
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`If you want to use hyperion as 'normal user', please use [current stable version](https://github.com/hyperion-project/hyperion)`
Update README.md 2016-06-20 09:23:52 +02:00
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`Besides of that .... Feel free to join us! We are looking always for people who wants to participate.`
Update readme Former-commit-id: ac30989b4c20cc2074629a14d43b844cc5bd573f 2013-10-10 09:55:44 +02:00
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`--------`
Update README.md 2016-06-21 23:11:47 +02:00
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`Hyperion is an opensource 'AmbiLight' implementation with support for many LED devices and video grabbers.`
Update README.md 2016-06-21 23:11:47 +02:00
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`The main features of Hyperion are:`
			`* Low CPU load makes it perfect for SoCs like Raspberry Pi`
			`* Json interface which allows easy integration into scripts`
			`* A command line utility to for testing and integration in automated environment`
			`* Priority channels are not coupled to a specific led data provider which means that a provider can post led data and leave without the need to maintain a connection to Hyperion. This is ideal for a remote application (like our Android app).`
			`* Black border detector.`
			`* A scriptable (Python) effect engine`
			`* A web ui to configure and remote control hyperion`

			`More information can be found on the official Hyperion [Wiki](https://wiki.hyperion-project.org)`
Update README.md Former-commit-id: a1bc04f01efe52cb87f85aa68e8f181c0e95900b 2016-04-30 01:14:28 +02:00
			`If you need further support please open a topic at the our new forum!`
			`[Hyperion webpage/forum](https://www.hyperion-project.org).`
Update README.md Updated the README description 2013-08-14 11:03:41 +02:00
Python 3.4 (#479) * Python 3 * fix travis osx * try fix * get info * digging in the dirt * . * . * cleanup * . * . * finalize, add multi threaded python support 2017-10-13 17:49:29 +02:00			`## Requirements`
even more changes Signed-off-by: Paulchen-Panther <Paulchen--Panter@gmx.net> 2018-12-28 18:12:45 +01:00			`* Debian 9, Ubuntu 16.04 or higher. Windows is not supported currently.`
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00
Python 3.4 (#479) * Python 3 * fix travis osx * try fix * get info * digging in the dirt * . * . * cleanup * . * . * finalize, add multi threaded python support 2017-10-13 17:49:29 +02:00			`## Building`
Update README.md (#316) wrong linking 2016-12-06 12:54:34 +01:00			`See [Compilehowto](CompileHowto.md) and [CrossCompileHowto](CrossCompileHowto.txt).`
update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00
Python 3.4 (#479) * Python 3 * fix travis osx * try fix * get info * digging in the dirt * . * . * cleanup * . * . * finalize, add multi threaded python support 2017-10-13 17:49:29 +02:00			`## Download`
			`A download isn't available, you need to compile your own version see "Building"`

update Readme and compile howto (#306) update readme and compile howto 2016-12-02 22:47:09 +01:00			`## License`
Update README.md Updated the README description 2013-08-14 11:03:41 +02:00			`The source is released under MIT-License (see http://opensource.org/licenses/MIT).`