frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2025-03-01 10:33:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

update Readme and compile howto (#306)

Browse Source 
update readme and compile howto
This commit is contained in:
redPanther
2016-12-02 22:47:09 +01:00
committed by GitHub
parent 96e8c29582
commit 82a140f5ed
2 changed files with 96 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -3,22 +3,38 @@ HYPERION
This is a pre alpha development repository for the next major version of hyperion
Feel free to join us! We are looking always for people who wants to participate.
--------
## **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!
Current new deps (libs)
QT5
- sudo apt-get install libqt5core5a libqt5network5 libqt5gui5 libqt5serialport5 libusb-1.0-0
If you want to use hyperion as 'normal user', please use [current stable version](https://github.com/hyperion-project/hyperion)
zeroconf
- apt-get install libavahi-core-dev libavahi-compat-libdnssd-dev
Besides of that .... Feel free to join us! We are looking always for people who wants to participate.
--------
94MB free disc space for deps
Hyperion is an opensource 'AmbiLight' implementation with support for many LED devices and video grabbers.
More information can be found on the official Hyperion [Wiki](https://wiki.hyperion-project.org)
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).
* Kodi-checker which checks the playing status of Kodi and decides whether or not to capture the screen.
* 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).
## Building
See [Compilehowto](CompileHowto.txt) and [CrossCompileHowto](CrossCompileHowto.txt).
## License
The source is released under MIT-License (see http://opensource.org/licenses/MIT).