mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
Readme slightly improved
This commit is contained in:
parent
e3b494428a
commit
7840317cc0
@ -1,7 +1,9 @@
|
||||
|
||||
# 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:
|
||||
On the following operating systems, Hyperion can currently be installed/updated using the method listed below:
|
||||
|
25
README.md
25
README.md
@ -4,8 +4,10 @@
|
||||
[](https://github.com/hyperion-project/hyperion.ng/releases)
|
||||
[](https://github.com/hyperion-project/hyperion.ng/actions)
|
||||
[](https://lgtm.com/projects/g/hyperion-project/hyperion.ng/alerts/)
|
||||
[](https://codedocs.xyz/hyperion-project/hyperion.ng/)
|
||||
[](#)
|
||||
[](https://www.hyperion-project.org)
|
||||
[](https://docs.hyperion-project.org)
|
||||
[](https://discord.gg/khkR8Vx3ff)
|
||||

|
||||
|
||||
## About Hyperion
|
||||
|
||||
@ -24,12 +26,12 @@
|
||||
* A multi language web interface to configure and remote control hyperion
|
||||
|
||||
If you need further support please open a topic at the forum!<br>
|
||||
[](https://www.hyperion-project.org)
|
||||
[](https://www.hyperion-project.org)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Feel free to join us! We are looking always for people who wants to participate.<br>
|
||||
[](https://github.com/hyperion-project/hyperion.ng/graphs/contributors)
|
||||
[](https://github.com/hyperion-project/hyperion.ng/graphs/contributors)
|
||||
|
||||
For an example, you can participate in the translation.<br>
|
||||
[](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)
|
||||
|
||||
## Documentation
|
||||
Covers these topics (WorkInProgress)
|
||||
- Installation
|
||||
- Configuration
|
||||
- Effect development
|
||||
- JSON API
|
||||
Covers these topics:
|
||||
- [Installation](https://docs.hyperion-project.org/en/user/Installation.html)
|
||||
- [Configuration](https://docs.hyperion-project.org/en/user/Configuration.html)
|
||||
- [Effect development](https://docs.hyperion-project.org/en/effects/#effect-files)
|
||||
- [JSON API](https://docs.hyperion-project.org/en/json/)
|
||||
|
||||
[](https://docs.hyperion-project.org)
|
||||
|
||||
## Changelog
|
||||
Released and unreleased changes at [Changelog.md](CHANGELOG.md)
|
||||
Released and unreleased changes at [CHANGELOG.md](CHANGELOG.md)
|
||||
|
||||
## Building
|
||||
See [CompileHowto](doc/development/CompileHowto.md).
|
||||
|
||||
## Installation
|
||||
See [Documentation](#documentation) or at [Installation.md](Installation.md).
|
||||
|
||||
## Download
|
||||
Releases available from the [Hyperion release page](https://github.com/hyperion-project/hyperion.ng/releases)
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user