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

Readme slightly improved

Browse Source
This commit is contained in:
Markus 2021-12-03 12:17:43 +00:00 committed by GitHub
parent e3b494428a
commit 7840317cc0
2 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Installation.md
View File

@ -1,7 +1,9 @@
# Installation # Installation
This page contains general installation steps for Hyperion.
This page contains general installation steps for Hyperion. For Linux please follow the instructions below. For Windows is an installation file available on our [Release page](https://github.com/hyperion-project/hyperion.ng/releases). ## Windows & macOS
For Windows and macOS is an installation file available on our [Release page](https://github.com/hyperion-project/hyperion.ng/releases).
## Linux: ## Linux:
On the following operating systems, Hyperion can currently be installed/updated using the method listed below: On the following operating systems, Hyperion can currently be installed/updated using the method listed below:

25
README.md
View File

@ -4,8 +4,10 @@
[![Latest-Release](https://img.shields.io/github/v/release/hyperion-project/hyperion.ng?include_prereleases)](https://github.com/hyperion-project/hyperion.ng/releases) [![Latest-Release](https://img.shields.io/github/v/release/hyperion-project/hyperion.ng?include_prereleases)](https://github.com/hyperion-project/hyperion.ng/releases)
[![GitHub Actions](https://github.com/hyperion-project/hyperion.ng/workflows/Hyperion%20CI%20Build/badge.svg?branch=master)](https://github.com/hyperion-project/hyperion.ng/actions) [![GitHub Actions](https://github.com/hyperion-project/hyperion.ng/workflows/Hyperion%20CI%20Build/badge.svg?branch=master)](https://github.com/hyperion-project/hyperion.ng/actions)
[![LGTM](https://img.shields.io/lgtm/alerts/g/hyperion-project/hyperion.ng.svg)](https://lgtm.com/projects/g/hyperion-project/hyperion.ng/alerts/) [![LGTM](https://img.shields.io/lgtm/alerts/g/hyperion-project/hyperion.ng.svg)](https://lgtm.com/projects/g/hyperion-project/hyperion.ng/alerts/)
[![Documentation](https://codedocs.xyz/hyperion-project/hyperion.ng.svg)](https://codedocs.xyz/hyperion-project/hyperion.ng/) [![Forum](https://img.shields.io/website/https/hyperion-project.org.svg?label=Forum&down_color=red&down_message=offline&up_color=green&up_message=online)](https://www.hyperion-project.org)
[![made-with-love](https://img.shields.io/badge/Made%20with-♥-ff0000.svg)](#) [![Documentation](https://img.shields.io/website?down_message=offline&label=Documentation%20%20&up_message=online&url=https%3A%2F%2Fdocs.hyperion-project.org)](https://docs.hyperion-project.org)
[![Discord](https://img.shields.io/discord/785578322167463937?label=Discord)](https://discord.gg/khkR8Vx3ff)
![made-with-love](https://img.shields.io/badge/Made%20with-♥-ff0000.svg)
## About Hyperion ## About Hyperion
@ -24,12 +26,12 @@
* A multi language web interface to configure and remote control hyperion * A multi language web interface to configure and remote control hyperion
If you need further support please open a topic at the forum!<br> If you need further support please open a topic at the forum!<br>
[![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) [![Forum](https://img.shields.io/website/https/hyperion-project.org.svg?label=Forum&down_color=red&down_message=offline&up_color=green&up_message=online)](https://www.hyperion-project.org)
## Contributing ## Contributing
Contributions are welcome! Feel free to join us! We are looking always for people who wants to participate.<br> Contributions are welcome! Feel free to join us! We are looking always for people who wants to participate.<br>
[![Contributors](https://img.shields.io/github/contributors/hyperion-project/hyperion.ng.svg)](https://github.com/hyperion-project/hyperion.ng/graphs/contributors) [![Contributors](https://img.shields.io/github/contributors/hyperion-project/hyperion.ng.svg?label=Contributors)](https://github.com/hyperion-project/hyperion.ng/graphs/contributors)
For an example, you can participate in the translation.<br> For an example, you can participate in the translation.<br>
[![Join Translation](https://img.shields.io/badge/POEditor-translate-green.svg)](https://poeditor.com/join/project/Y4F6vHRFjA) [![Join Translation](https://img.shields.io/badge/POEditor-translate-green.svg)](https://poeditor.com/join/project/Y4F6vHRFjA)
@ -39,20 +41,23 @@ For an example, you can participate in the translation.<br>
Find here more details on [supported platforms and configuration sets](doc/development/SupportedPlatforms.md) Find here more details on [supported platforms and configuration sets](doc/development/SupportedPlatforms.md)
## Documentation ## Documentation
Covers these topics (WorkInProgress) Covers these topics:
- Installation - [Installation](https://docs.hyperion-project.org/en/user/Installation.html)
- Configuration - [Configuration](https://docs.hyperion-project.org/en/user/Configuration.html)
- Effect development - [Effect development](https://docs.hyperion-project.org/en/effects/#effect-files)
- JSON API - [JSON API](https://docs.hyperion-project.org/en/json/)
[![Visit Documentation](https://img.shields.io/website?down_message=offline&label=Documentation%20%20&up_message=online&url=https%3A%2F%2Fdocs.hyperion-project.org)](https://docs.hyperion-project.org) [![Visit Documentation](https://img.shields.io/website?down_message=offline&label=Documentation%20%20&up_message=online&url=https%3A%2F%2Fdocs.hyperion-project.org)](https://docs.hyperion-project.org)
## Changelog ## Changelog
Released and unreleased changes at [Changelog.md](CHANGELOG.md) Released and unreleased changes at [CHANGELOG.md](CHANGELOG.md)
## Building ## Building
See [CompileHowto](doc/development/CompileHowto.md). See [CompileHowto](doc/development/CompileHowto.md).
## Installation
See [Documentation](#documentation) or at [Installation.md](Installation.md).
## Download ## Download
Releases available from the [Hyperion release page](https://github.com/hyperion-project/hyperion.ng/releases) Releases available from the [Hyperion release page](https://github.com/hyperion-project/hyperion.ng/releases)