mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
Update Instructions (Docker Compile, Supported platforms, License year) (#1682)
Correct docker compile to load repository
This commit is contained in:
LordGrey
GitHub
parent
eb0964078f
commit
5cd21f50be
@ -124,8 +124,9 @@ The amount of "%" must match with following arguments
|
||||
If you want to use VSCode for development follow the steps.
|
||||
|
||||
- Install [VSCode](https://code.visualstudio.com/). On Ubuntu 16.04+ you can also use the [Snapcraft VSCode](https://snapcraft.io/code) package.
|
||||
- Linux: Install gdb `sudo apt-get install gdb`
|
||||
- Mac: ?
|
||||
- Install gdb:
|
||||
- Linux: `sudo apt-get install gdb`
|
||||
- Mac: `brew install gdb`
|
||||
- Open VSCode and click on _File_ -> _Open Workspace_ and select the file `hyperion.ng/.vscode/hyperion.code-workspace`
|
||||
- Install recommended extensions
|
||||
- If you installed the Task Explorer you can now use the defined vscode tasks to build Hyperion and configure cmake
|
||||
|
||||
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2014-2023 Hyperion Project
|
||||
Copyright (c) 2014-2024 Hyperion Project
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
@ -10,6 +10,7 @@
|
||||
[](https://www.hyperion-project.org)
|
||||
[](https://docs.hyperion-project.org)
|
||||
[](https://discord.gg/XtVTb3HEKS)
|
||||
[](https://releases.hyperion-project.org)
|
||||
|
||||
|
||||
## About Hyperion
|
||||
@ -66,7 +67,7 @@ See [CompileHowto.md](doc/development/CompileHowto.md).
|
||||
See [Documentation](https://docs.hyperion-project.org/en/user/Installation.html) or on the [Release Repository](https://releases.hyperion-project.org).
|
||||
|
||||
## Download
|
||||
Releases available from the [Hyperion release page](https://github.com/hyperion-project/hyperion.ng/releases).
|
||||
GitHub Releases are available on the [Hyperion release page](https://github.com/hyperion-project/hyperion.ng/releases).
|
||||
|
||||
## Privacy Policy
|
||||
See [PRIVACY.md](PRIVACY.md).
|
||||
|
||||
@ -226,7 +226,7 @@ log "---> BASE_PATH = ${BASE_PATH}"
|
||||
CODE_PATH=${BASE_PATH};
|
||||
|
||||
# get Hyperion source, cleanup previous folder
|
||||
if [ ${BUILD_LOCAL} == 0 ]; then
|
||||
if [ ${BUILD_LOCAL} == false ]; then
|
||||
CODE_PATH="${CODE_PATH}/hyperion/"
|
||||
|
||||
echo "---> Downloading Hyperion source code from ${GIT_REPO_URL}"
|
||||
|
||||
@ -3,52 +3,54 @@
|
||||
If you are using [Docker](https://www.docker.com/), you can compile Hyperion inside a docker container. This keeps your system clean and with a simple script it's easy to use. Supported is also cross compiling for Raspberry Pi (Debian Buster or higher). To compile Hyperion just execute one of the following commands.
|
||||
|
||||
The compiled binaries and packages will be available at the deploy folder next to the script.<br/>
|
||||
Note: call the script with `./docker-compile.sh -h` for more options.
|
||||
|
||||
## Cross compilation on x86_64 for:
|
||||
> [!NOTE]
|
||||
> Call the script with `./docker-compile.sh --help` for more options.
|
||||
|
||||
**x86_64 (Debian Buster):**
|
||||
## Cross compilation on amd64 (aka x86_64), sample commands
|
||||
|
||||
### Debian
|
||||
|
||||
**amd64 (Bookworm):**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i x86_64 -t buster
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh --name bookworm
|
||||
```
|
||||
**x86_64 (Debian Bullseye):**
|
||||
**arm64 or Raspberry Pi 5 (Bookworm)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i x86_64 -t bullseye
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh --architecture arm64 --name bookworm
|
||||
```
|
||||
**x86_64 (Debian Bookworm):**
|
||||
**Raspberry Pi 2/3/4 (Bookworm)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i x86_64 -t bookworm
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh --architecture arm/v7 --name bookworm
|
||||
```
|
||||
**Raspberry Pi v1 & ZERO (Debian Buster)**
|
||||
**Raspberry Pi v1 & ZERO (Bookworm)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv6l -t buster
|
||||
```
|
||||
**Raspberry Pi v1 & ZERO (Debian Bullseye)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv6l -t bullseye
|
||||
```
|
||||
**Raspberry Pi v1 & ZERO (Debian Bookworm)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv6l -t bookworm
|
||||
```
|
||||
**Raspberry Pi 2/3/4 (Debian Buster)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv7l -t buster
|
||||
```
|
||||
**Raspberry Pi 2/3/4 (Debian Bullseye)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv7l -t bullseye
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh --architecture arm/v6 --name bookworm
|
||||
```
|
||||
|
||||
## Cross compilation on x86_64 for developers
|
||||
### Ubuntu
|
||||
|
||||
**amd64 (Jammy):**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh --name jammy
|
||||
```
|
||||
|
||||
### Fedora
|
||||
|
||||
**amd64 (39):**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh --name 39
|
||||
```
|
||||
|
||||
## Cross compilation on amd64 for developers
|
||||
Using additional options you can cross compile locally
|
||||
-l: use a local hyperion source code directory rather than cloning from GitHub
|
||||
-c: do incremental compiles, Note: you need to keep the image and tag stable
|
||||
--local: use a local hyperion source code directory rather than cloning from GitHub
|
||||
--incremental: do incremental compiles, Note: you need to keep the image and tag stable
|
||||
|
||||
**Compile code in $HYPERION_HOME incrementally for Raspberry Pi 2/3/4 (Debian Bullseye)**
|
||||
**Compile code in $HYPERION_HOME incrementally for Raspberry Pi 2/3/4 (Debian Bookworm)**
|
||||
```console
|
||||
cd $HYPERION_HOME
|
||||
./bin/scripts/docker-compile.sh -l -c -i armv7l -t bullseye
|
||||
./bin/scripts/docker-compile.sh --local --incremental --architecture arm/v7 --name bookworm
|
||||
```
|
||||
|
||||
# The usual way
|
||||
@ -113,11 +115,11 @@ sudo dnf install python3-devel qt-devel qt5-qtbase-devel qt5-qtserialport-devel
|
||||
After installing the dependencies, you can continue with the compile instructions later on this page (the more detailed way..).
|
||||
|
||||
## OSX
|
||||
To install on OS X you either need Homebrew or Macport but Homebrew is the recommended way to install the packages. To use Homebrew XCode is required as well, use `brew doctor` to check your install.
|
||||
To install on OS X you either need [Homebrew](https://brew.sh/) or [Macport](https://www.macports.org/) but Homebrew is the recommended way to install the packages. To use Homebrew, XCode is required as well, use `brew doctor` to check your install.
|
||||
|
||||
First you need to install the dependencies:
|
||||
```console
|
||||
brew install qt5 python3 cmake libusb doxygen
|
||||
brew install git qt@5 python3 cmake libusb openssl@1.1
|
||||
```
|
||||
|
||||
## Windows
|
||||
@ -127,13 +129,13 @@ We assume a 64bit Windows 10. Install the following;
|
||||
- [Visual Studio 2022 Community Edition](https://visualstudio.microsoft.com/downloads/#visual-studio-community-2022)
|
||||
- Select 'Desktop development with C++'
|
||||
- On the right, just select `MSVC v143 VS 2022 C++ x64/x86-Buildtools` and latest `Windows 10 SDK`. Everything else is not needed.
|
||||
- [Win64 OpenSSL v1.1.1k](https://slproweb.com/products/Win32OpenSSL.html) ([direct link](https://slproweb.com/download/Win64OpenSSL-1_1_1k.exe))
|
||||
- [Win64 OpenSSL v1.1.1w](https://slproweb.com/products/Win32OpenSSL.html) ([direct link](https://slproweb.com/download/Win64OpenSSL-1_1_1w.exe))
|
||||
- [Python 3 (Windows x86-64 executable installer)](https://www.python.org/downloads/windows/) (Check: Add to PATH and Debug Symbols)
|
||||
- Open a console window and execute `pip install aqtinstall`.
|
||||
- Now we can download Qt to _C:\Qt_ `mkdir c:\Qt && aqt install -O c:\Qt 5.15.2 windows desktop win64_msvc2019_64`
|
||||
- QT6.2 requires the [Vulkan SDK](https://vulkan.lunarg.com/sdk/home) to be installed
|
||||
- [libjpeg-turbo SDK for Visual C++](https://sourceforge.net/projects/libjpeg-turbo/files/)
|
||||
- Download the latest 64bit installer (currently `libjpeg-turbo-2.1.3-vc64.exe`) and install to its default location `C:\libjpeg-turbo64`.
|
||||
- Download the latest 64bit installer (currently `libjpeg-turbo-3.0.1-vc64.exe`) and install to its default location `C:\libjpeg-turbo64`.
|
||||
|
||||
### Optional:
|
||||
- For DirectX9 grabber:
|
||||
@ -171,7 +173,7 @@ bin/hyperiond
|
||||
# webui is located on localhost:8090 or 8091
|
||||
```
|
||||
|
||||
In case you would like to build with a dedicated Qt version, Either supply ``QTDIR`` as ``-DQTDIR=<path>`` to cmake or set and environment variable ``QTDIR`` pointing to the Qt installation.
|
||||
In case you would like to build with a dedicated Qt version, Either supply ``QTDIR`` as ``-DQTDIR=<path>`` to CMake or set an environment variable ``QTDIR`` pointing to the Qt installation.
|
||||
|
||||
On Windows MSVC2022 set it via the CMakeSettings.json:
|
||||
```posh
|
||||
@ -180,7 +182,7 @@ On Windows MSVC2022 set it via the CMakeSettings.json:
|
||||
...
|
||||
"environments": [
|
||||
{
|
||||
"QTDIR": "C:/Qt/6.2.2/msvc2019_64/"
|
||||
"QTDIR": "C:/Qt/6.5.3/msvc2019_64/"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@ -1,26 +1,29 @@
|
||||
# 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/).
|
||||
The GitHub releases of Hyperion are currently supported 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 | Screen-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 | 20.04, 22.04, 23.04² | QT¹<br/>XCB/X11¹ | [Linux-x86_64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| X64 | Debian | 10, 11, 12³ | QT¹<br/>XCB/X11¹ | [Linux-x86_64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 4 | HyperBian | 10, 11, 12³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [HyperBian.zip](https://github.com/Hyperion-Project/HyperBian/releases) | |
|
||||
| RPi 4 | Raspberry Pi OS | 10, 11, 12³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-armv7l.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 3 /3+ | HyperBian | 10, 11, 12³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [HyperBian.zip](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 3 /3+ | Raspberry Pi OS | 10, 11, 12³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-armv7l.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| amd64 | Windows | 10 | QT¹ | [windows-x64.exe](https://github.com/hyperion-project/hyperion.ng/releases) | Direct X9 Grabber via self-compile |
|
||||
| amd64 | Ubuntu | 20.04, 22.04, 24.04² | QT¹<br/>XCB/X11¹ | [Linux-amd64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| amd64 | Debian | 10, 11, 12, 13³ | QT¹<br/>XCB/X11¹ | [Linux-amd.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 5 | HyperBian | 10, 11, 12, 13³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [HyperBian.zip](https://github.com/Hyperion-Project/HyperBian/releases) | |
|
||||
| RPi 5 | Raspberry Pi OS | 12, 13³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-arm64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 4 | HyperBian | 10, 11, 12, 13³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [HyperBian.zip](https://github.com/Hyperion-Project/HyperBian/releases) | |
|
||||
| RPi 4 | Raspberry Pi OS | 10, 11, 12, 13³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-armv7l.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 3 /3+ | HyperBian | 10, 11, 12, 13³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [HyperBian.zip](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 3 /3+ | Raspberry Pi OS | 10, 11, 12, 13³ | QT¹<br/>XCB/X11¹<br/>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 | Screen-Grabber | Package | Comments |
|
||||
|---------------|-----------------|----------------|-----------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| X64 | macOS | 11, 12 | QT<br>OSX | [macOS-x86_64.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | M1 not tested |
|
||||
| X64 | Fedora | 38 | QT¹<br/>XCB/X11¹ | [Linux-x86_64.rpm](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| X64 | macOS | 11, 12 | QT<br>OSX | [macOS-x86_x64.dmg](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| X64 | Fedora | 39 | QT¹<br/>XCB/X11¹ | [Linux-x86_64.rpm](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| X64 | Arch | | QT¹<br/>XCB/X11¹ | [Linux-x86_64.rpm](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 0/ 1 / 2 | Raspberry Pi OS | 10, 11, 12³| QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-armv6l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | No recommended |
|
||||
| X64 | LibreElec | 11.x (Nexus) | [Kodi add-on](https://github.com/hyperion-project/hyperion.kodi/releases) | [Linux-x86_64.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/) |
|
||||
@ -40,5 +43,5 @@ In case you have an additional working setups you would like to share with the c
|
||||
Legend
|
||||
---
|
||||
¹ Requires an environment with `DISPLAY` defined\
|
||||
² 20=Focal Fossa, 22=Jammy Jellyfish, 23=Lunar Lobster\
|
||||
³ 10=Buster, 11=Bullseye, 12=Bookworm
|
||||
² 20=Focal Fossa, 22=Jammy Jellyfish, 24=Lunar Lobster, 24=Noble Numbat\
|
||||
³ 10=Buster, 11=Bullseye, 12=Bookworm, 13=Trixie
|
||||
|
||||
@ -140,7 +140,7 @@ if(APPLE)
|
||||
MACOSX_BUNDLE_INFO_PLIST ${CMAKE_SOURCE_DIR}/cmake/osxbundle/Info.plist.in
|
||||
MACOSX_BUNDLE_BUNDLE_NAME "Hyperion"
|
||||
MACOSX_BUNDLE_BUNDLE_VERSION ${HYPERION_VERSION}
|
||||
MACOSX_BUNDLE_COPYRIGHT "Copyright(c) 2014-2023 Hyperion Project"
|
||||
MACOSX_BUNDLE_COPYRIGHT "Copyright(c) 2014-2024 Hyperion Project"
|
||||
MACOSX_BUNDLE_GUI_IDENTIFIER "com.hyperion-project.${PROJECT_NAME}"
|
||||
MACOSX_BUNDLE_ICON_FILE "Hyperion.icns"
|
||||
MACOSX_BUNDLE_INFO_STRING "${PROJECT_NAME} ${HYPERION_VERSION}"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user