diff --git a/launchers/qt/BUILD.md b/launchers/qt/BUILD.md new file mode 100644 index 0000000000..de6b91458c --- /dev/null +++ b/launchers/qt/BUILD.md @@ -0,0 +1,11 @@ +# Dependencies +- [cmake](https://cmake.org/download/): 3.9 + +# Windows +cmake -G "Visual Studio 16 2019" .. + +# OSX +cmake -G Xcode .. + + +if you wish to not use the compiled qml files pass the `-DLAUNCHER_SOURCE_TREE_RESOURCES=On` argument to cmake. \ No newline at end of file diff --git a/launchers/qt/readme.md b/launchers/qt/readme.md new file mode 100644 index 0000000000..fda076340a --- /dev/null +++ b/launchers/qt/readme.md @@ -0,0 +1,20 @@ +# HQ Launcher +Behavior of the HQ Launcher is as follows: +* Launching the user in the current HQ domain +* Update the Interface client to the current version. +* Update the HQ Launcher to the current version + +# directory structure + +## src/ - contains the c++ and objective-c. +* LauncherState - hold majority of the logic of the launcher (signin, config file, updating, running launcher) +* LauncherInstaller_windows - logic of how to install/uninstall HQ Launcher on windows +* Helper - helper functions +* UserSettings - getting the users setting (home location) from metaverse +* BuildsRequest - getting / parsing the build info from thunder api +* LoginRequest - checks the login credentials the user typed in. +* Unzipper - helper class for extracting zip files + +## resources/ +* image/ - Holds the images and icon that are used by the launcher +* qml/ - UI elements - `QML_FILE_FOR_UI_STATE` varible in LauchherState defines what qml files are used by the laucnher. \ No newline at end of file