diff --git a/README.md b/README.md index e6258b08..91922902 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,9 @@ Contributions are welcome! Feel free to join us! We are looking always for peopl 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. +## Supported Platforms -We provide a macOS Build but we can not support this. +Find here more details on [supported platforms and configuration sets](doc/development/SupportedPlatforms.md) ## Documentation Covers these topics (WorkInProgress) @@ -51,7 +50,7 @@ Covers these topics (WorkInProgress) Released and unreleased changes at [Changelog.md](CHANGELOG.md) ## Building -See [CompileHowto](CompileHowto.md) and [CrossCompileHowto](CrossCompileHowto.md). +See [CompileHowto](doc/development/CompileHowto.md). ## Download Alpha releases available from the [Hyperion release page](https://github.com/hyperion-project/hyperion.ng/releases) diff --git a/CompileHowto.md b/doc/development/CompileHowto.md similarity index 100% rename from CompileHowto.md rename to doc/development/CompileHowto.md diff --git a/doc/development/Hyperion-platforms_supported.xlsx b/doc/development/Hyperion-platforms_supported.xlsx new file mode 100644 index 00000000..dbe51323 Binary files /dev/null and b/doc/development/Hyperion-platforms_supported.xlsx differ diff --git a/development/LedDevice_Flows.drawio b/doc/development/LedDevice_Flows.drawio similarity index 100% rename from development/LedDevice_Flows.drawio rename to doc/development/LedDevice_Flows.drawio diff --git a/development/LedDevice_Flows.png b/doc/development/LedDevice_Flows.png similarity index 100% rename from development/LedDevice_Flows.png rename to doc/development/LedDevice_Flows.png diff --git a/doc/development/SupportedPlatforms.md b/doc/development/SupportedPlatforms.md new file mode 100644 index 00000000..93525e73 --- /dev/null +++ b/doc/development/SupportedPlatforms.md @@ -0,0 +1,40 @@ +# Hyperion - Supported platforms +Hyperion is currently suported on the following sets of configuration: +> **_NOTE:_** Configurations tagged as unofficial are running in general, but are provided/maintained on a best effort basis.\ +In case of problems, it is recommended checking with the wider Hyperion community (https://hyperion-project.org/forum/). + +## Official +| Hardware | OS | Version | Grabber | Package | Comments | +|-----------|-----------------|--------------------|-----------------------------------------|-------------------------------------------------------------------------------|------------------------------------| +| X64 | Windows | 10 | QT¹ | [Windows-AMD64.exe](https://github.com/hyperion-project/hyperion.ng/releases) | Direct X9 Grabber via self-compile | +| X64 | Ubuntu | 18.04, 20.04² | QT¹
XCB/X11¹ | [Linux-x86_64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | | +| X64 | Debian | 9, 10³ | QT¹
XCB/X11¹ | [Linux-x86_64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | | +| RPi 4 | HyperBian | 9, 10³ | QT¹
XCB/X11¹
DispmanX | [HyperBian.zip](https://github.com/Hyperion-Project/HyperBian/releases) | | +| RPi 4 | Raspberry Pi OS | 9, 10³ | QT¹
XCB/X11¹
DispmanX | [Linux-armv7l.deb](https://github.com/hyperion-project/hyperion.ng/releases) | | +| RPi 3 /3+ | HyperBian | 9, 10³ | QT¹
XCB/X11¹
DispmanX | [HyperBian.zip](https://github.com/hyperion-project/hyperion.ng/releases) | | +| RPi 3 /3+ | Raspberry Pi OS | 9, 10³ | QT¹
XCB/X11¹
DispmanX | [Linux-armv7l.deb](https://github.com/hyperion-project/hyperion.ng/releases) | | + +## Unofficial +In case you have an additional working setups you would like to share with the community, please get in touch or issue a PR to have the table updated. + +| Hardware | OS | Version | Grabber | Package | Comments | +|---------------|-----------------|---------------|-----------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| X64 | macOS | 11 | QT
OSX | [macOS-x86_64.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | M1 not tested | +| X64 | Fedora | | QT¹
XCB/X11¹ | [Linux-x86_64.rpm](https://github.com/hyperion-project/hyperion.ng/releases) | | +| X64 | Arch | | QT¹
XCB/X11¹ | [Linux-x86_64.rpm](https://github.com/hyperion-project/hyperion.ng/releases) | | +| RPi 0/ 1 / 2 | Raspberry Pi OS | 9, 10³ | QT¹
XCB/X11¹
DispmanX | [Linux-armv6l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | No recommended | +| RPi 4 | LibreElec | 10.x (Matrix) | QT¹ | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) | +| RPi 4 | LibreElec | 9.2.x (Leia) | QT¹
DispmanX | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) | +| RPi 3 /3+ | LibreElec | 10.x (Matrix) | QT¹ | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) | +| RPi 3 /3+ | LibreElec | 9.2.x (Leia) | QT¹
DispmanX | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) | +| Amlogic | CoreElec | 19.x (Matrix) | Amlogic | CoreElec Plugin | Supported via CoreElec project | +| Amlogic | CoreElec | 9.2.x (Leia) | Amlogic | CoreElec Plugin | Supported via CoreElec project | +| Vero4K | OSMC | | | | [hyperion-vero4k](https://github.com/hissingshark/hyperion-vero4k) | +| LG TV | webOS | | - | | [hyperion-webos](https://github.com/webosbrew/hyperion-webos) | + +Legend +--- +¹ Requires an environment with `DISPLAY` defined\ +² 18=Bionic Beaver 20=Focal Fossa\ +³ 9=Stretch, 10=Buster +