forked from hyperion-project/hyperion.ng
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revised Readme.md Signed-off-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>
- Loading branch information
1 parent
d40aa71
commit ff93dd3
Showing
15 changed files
with
116 additions
and
117 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
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
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
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
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,68 +1,47 @@ | ||
<p align="center"> | ||
<img src="./assets/webconfig/img/hyperion/hyperionlogo.png" height="130"> | ||
</p> | ||
![Hyperion.NG](https://raw.githubusercontent.com/hyperion-project/hyperion.ng/master/assets/webconfig/img/hyperion/hyperionlogo.png) | ||
|
||
<p align="center"> | ||
<a href="https://www.hyperion-project.org" alt="Forum"> | ||
<img src="https://img.shields.io/website/https/hyperion-project.org.svg?down_color=red&down_message=offline&up_color=green&up_message=online" /></a> | ||
<a href="https://github.com/hyperion-project/hyperion.ng/graphs/contributors" alt="Contributors"> | ||
<img src="https://img.shields.io/github/contributors/hyperion-project/hyperion.ng.svg" /></a> | ||
<a href="https://github.com/hyperion-project/hyperion.ng/tree/master/dependencies/external" alt="Dependencies"> | ||
<img src="https://img.shields.io/librariesio/github/hyperion-project/hyperion.ng.svg" /></a> | ||
<a href="https://dev.azure.com/Hyperion-Project/Hyperion.NG/_build/latest?definitionId=7&branchName=master" alt="Azure-Pipeline"> | ||
<img src="https://dev.azure.com/Hyperion-Project/Hyperion.NG/_apis/build/status/Hyperion.NG?branchName=master" /></a> | ||
<a href="https://travis-ci.org/hyperion-project/hyperion.ng" alt="Travis-CI"> | ||
<img src="https://travis-ci.org/hyperion-project/hyperion.ng.svg?branch=master" /></a> | ||
<a href="https://lgtm.com/projects/g/hyperion-project/hyperion.ng/alerts/"> | ||
<img src="https://img.shields.io/lgtm/alerts/g/hyperion-project/hyperion.ng.svg" | ||
alt="Total alerts"/></a> | ||
<a href="https://raw.githubusercontent.com/hyperion-project/hyperion.ng/master/LICENSE"> | ||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" | ||
alt="GitHub license"></a> | ||
<a href="https://poeditor.com/join/project/Y4F6vHRFjA"> | ||
<img src="https://img.shields.io/badge/POEditor-translate-green.svg" | ||
alt="Join Translation"></a> | ||
</p> | ||
[![Dependencies](https://img.shields.io/librariesio/github/hyperion-project/hyperion.ng.svg)](https://github.com/hyperion-project/hyperion.ng/tree/master/dependencies/external) | ||
[![Azure-Pipeline](https://dev.azure.com/Hyperion-Project/Hyperion.NG/_apis/build/status/Hyperion.NG?branchName=master)](https://dev.azure.com/Hyperion-Project/Hyperion.NG/_build/latest?definitionId=7&branchName=master) | ||
[![Travis-CI](https://travis-ci.org/hyperion-project/hyperion.ng.svg?branch=master)](https://travis-ci.org/hyperion-project/hyperion.ng) | ||
[![LGTM](https://img.shields.io/lgtm/alerts/g/hyperion-project/hyperion.ng.svg)](https://lgtm.com/projects/g/hyperion-project/hyperion.ng/alerts/) | ||
|
||
<p align="center">This is a pre alpha development repository for the next major version of hyperion</p> | ||
## About Hyperion | ||
|
||
-------- | ||
## **Important notice!** | ||
[Hyperion.NG](https://github.com/hyperion-project/hyperion.ng) is an opensource '[AmbiLight](https://de.wikipedia.org/wiki/Ambilight)' implementation with support for many LED devices and video grabbers. The project is still in a beta development stage (no stable release available). | ||
|
||
Hyperion.NG is under heavy development. This version is currently _only for development_ purpose. | ||
Please do not use it for your 'productiv' setup! | ||
![Screenshot](doc/screenshot.png) | ||
|
||
If you want to use hyperion as 'normal user', please use [current stable version](https://github.com/hyperion-project/hyperion) | ||
### Features: | ||
|
||
Besides of that .... Feel free to join us! We are looking always for people who wants to participate. | ||
|
||
-------- | ||
## About | ||
|
||
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. | ||
* 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](https://play.google.com/store/apps/details?id=nl.hyperion.hyperionpro)). | ||
* Black border detector and processor | ||
* A scriptable (Python) effect engine | ||
* A web ui to configure and remote control hyperion | ||
* A multi language web interface 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 forum! | ||
[![Hyperion webpage/forum](https://img.shields.io/website/https/hyperion-project.org.svg?down_color=red&down_message=offline&up_color=green&up_message=online)](https://www.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). | ||
## Contributing | ||
|
||
Contributions are welcome! Feel free to join us! We are looking always for people who wants to participate. | ||
[![Contributors](https://img.shields.io/github/contributors/hyperion-project/hyperion.ng.svg)](https://github.com/hyperion-project/hyperion.ng/graphs/contributors) | ||
|
||
For an example, you can participate in the translation. | ||
[![Join Translation](https://img.shields.io/badge/POEditor-translate-green.svg)](https://poeditor.com/join/project/Y4F6vHRFjA) | ||
|
||
## Requirements | ||
* Debian 9, Ubuntu 16.04 or higher. Windows is not supported currently. | ||
Debian 9, Ubuntu 16.04 or higher. Windows is not supported currently. | ||
|
||
## Building | ||
See [Compilehowto](CompileHowto.md) and [CrossCompileHowto](CrossCompileHowto.txt). | ||
See [CompileHowto](CompileHowto.md) and [CrossCompileHowto](CrossCompileHowto.txt). | ||
|
||
## Download | ||
A download isn't available, you need to compile your own version see "Building" | ||
**Please be patient. The first release is coming soon.** | ||
|
||
## License | ||
The source is released under MIT-License (see http://opensource.org/licenses/MIT). | ||
The source is released under MIT-License (see http://opensource.org/licenses/MIT). | ||
[![GitHub license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/hyperion-project/hyperion.ng/master/LICENSE) | ||
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
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
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
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
Oops, something went wrong.