hyperion.ng/docs
brindosch 510bb903ae
Windows compilation support (#738)
* Disable AVAHI

* Replace SysInfo backport with Qt SysInfo

* Update vscode config

* Update LedDevices

* Update Logger

* Update hyperiond

* Update hyperion-remote

* Exclude avahi

* Empty definition for Process

* PythonInit path broken

* Exclude PiBlaster and link ws2_32

* more avahi

* resolve ui bug

* Update Compile howto

* JsonAPI QtGrabber missing

* fix error

* ssize_t replacement

* Nope, doesn't work

* Adjust compile description and verify winSDK

* Update ci script

* Update ci script

* Update ci

* Update ci script

* update Logger

* Update PythonInit

* added Azure & GitHub Actions, Logger, PythonInit

* resolve merge conflicts

* revert ssize_t in FadeCandy

* look at registry for QT5 & use find_package(Python) if cmake >= 3.12

* second try

* another try

* and yet another test

* qt5 registry search undone

* Package creation test

* finished package creation. only fine tuning is required :-)

Signed-off-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>

* Dependencies for Windows finished

Signed-off-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>

* use 'add_definitions()' until CMake 3.12

Signed-off-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>

* Update .github/workflows/pull-request.yml

Co-Authored-By: Paulchen Panther <16664240+Paulchen-Panther@users.noreply.github.com>

* Update cmake/Dependencies.cmake

Co-Authored-By: brindosch <edeltraud70@gmx.de>

* fix typo/ add VCINSTALLDIR var

* fix again

* Undo change again (Not working)

* fix QT grabber

Signed-off-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>

* first NSIS test

Signed-off-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>

* Update NSIS package

* surprise :-)

Signed-off-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>

* Update NSIS package

* fix: NSIS .bmps

* Add nsis templates

* Force windows gui app

* fix: QSysInfo required Qt5.6, now it's 5.4 again

* Update: Remove platform component and adjust package name

* Add macOS as system name

* Update docs

* fix: Allow gh actions ci also for forks with branches

* Add ReadMe docs, mention windows, add vscode linux debug config

* fix: readme visual

* reduce/hide banner/copyright/log message

Infos here: https://docs.microsoft.com/de-de/visualstudio/msbuild/msbuild-command-line-reference?view=vs-2019#switches

* Fix PythonInit

* vscode: Add runner task

* fix(vscode): compiler path gcc ver independent

* fix azure

* vscode: add windows run tasks

* move process detection

* main: add windows process detection

* Azure file shredder

* Update docs

Co-authored-by: Paulchen Panther <16664240+Paulchen-Panther@users.noreply.github.com>
Co-authored-by: Paulchen-Panther <Paulchen-Panter@protonmail.com>
2020-05-12 19:51:19 +02:00
..
docs Windows compilation support (#738) 2020-05-12 19:51:19 +02:00
.gitignore feat(docs): Documentation for Hyperion (#780) 2020-05-01 20:19:19 +02:00
package.json feat(docs): Documentation for Hyperion (#780) 2020-05-01 20:19:19 +02:00
README.md feat(docs): Documentation for Hyperion (#780) 2020-05-01 20:19:19 +02:00
yarn.lock feat(docs): Documentation for Hyperion (#780) 2020-05-01 20:19:19 +02:00

Documentation

This folder contains the Hyperion documentation build files. It's written in Markdown with VuePress as static site generator.

Development

To edit or translate the documentation, it's not necessarily required to follow these steps (As we use Markdown). But if you want to check the results, please do so.

  • Install latest Node.js LTS
  • Open console
  • Install Yarn npm install -g yarn (If this does not work - logout/login)
  • Navigate with console to this directory
  • Do yarn install
  • Now you can start dev server with yarn docs:dev
  • Open Browser and go to address localhost:8080

Notes

  • If you want to view the deployable site locally run yarn docs:serve
  • Do not rename files and folders while translating
  • Copy/paste and translate also .vuepress/config.js at themeConfig.locales
  • Changes in .vuepress/config.js may lead to a bugged dev server. Restart.
  • To modify the sidebar pages checkout .vuepress/config.js at themeConfig.sidebar

Production

To get a deployable version run

  • yarn docs:build (while inside this folder)
  • Files will be in dist folder