From d8ba0564b528ae252391b1e5cb033c42e1769b02 Mon Sep 17 00:00:00 2001 From: Dante Ruiz Date: Fri, 22 Nov 2019 15:55:57 -0800 Subject: [PATCH 1/4] Adding QT Launcher Documention --- launchers/qt/BUILD.md | 11 +++++++++++ launchers/qt/readme.md | 20 ++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 launchers/qt/BUILD.md create mode 100644 launchers/qt/readme.md 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 From c08a18c517c0e23c34112f4bb1e0bcded92d4c62 Mon Sep 17 00:00:00 2001 From: danteruiz Date: Mon, 25 Nov 2019 14:50:58 -0800 Subject: [PATCH 2/4] making requested changes --- launchers/qt/BUILD.md | 10 ++++++---- launchers/qt/readme.md | 36 +++++++++++++++++++++++++----------- 2 files changed, 31 insertions(+), 15 deletions(-) diff --git a/launchers/qt/BUILD.md b/launchers/qt/BUILD.md index de6b91458c..d08aa6bfa0 100644 --- a/launchers/qt/BUILD.md +++ b/launchers/qt/BUILD.md @@ -2,10 +2,12 @@ - [cmake](https://cmake.org/download/): 3.9 # Windows -cmake -G "Visual Studio 16 2019" .. +* Download `Visual Studio 2019` +`cmake -G "Visual Studio 16 2019" ..` -# OSX -cmake -G Xcode .. +# MacOS +* Install `Xcode` +`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 +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 index fda076340a..beaa54eebe 100644 --- a/launchers/qt/readme.md +++ b/launchers/qt/readme.md @@ -1,20 +1,34 @@ # HQ Launcher Behavior of the HQ Launcher is as follows: +* Update the HQ Launcher to the latest version +* Sign up and sign in is the user is not +* Download the latest Interface client * 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 +* `BuildsRequest` - getting / parsing the build info from thunder api +* `CommandlineOptions` - parses and stores commandline arguments +* `Helper` - helper functions +* `Helper_darwin` - objective-c implemention of helper funcions +* `Helper_windows` - helper function that depend on windows api +* `Launcher` - initialized the Launcher Application and resources +* `LauncherInstaller_windows` - logic of how to install/uninstall HQ Launcher on windows +* `LauncherState` - hold majority of the logic of the launcher (signin, config file, updating, running launcher) + * config files hold the following saved data + * logged in + * home location +* `LauncherWindows` - wrapper for `QQuickWindow` that implements drag feature +* `LoginRequest` - checks the login credentials the user typed in. +* `NSTask+NSTaskExecveAddtions` - Extension of NSTask for replacing Launcher process with interface client process +* `PathUtils` - Helper class for getting relative paths for HQ Launcher +* `SignupRequest` - Determines if the users request to signup for a new account succeeded based on the entered credentials +* `Unzipper` - helper class for extracting zip files +* `UserSettingsRequest` - getting the users setting (home location) from metaverse ## 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 +* `images/`- 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 From e0c5edfccd6a4356f80ca0bd1450bf053169052c Mon Sep 17 00:00:00 2001 From: danteruiz Date: Mon, 25 Nov 2019 14:58:40 -0800 Subject: [PATCH 3/4] fix typos --- launchers/qt/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/launchers/qt/readme.md b/launchers/qt/readme.md index beaa54eebe..917c647511 100644 --- a/launchers/qt/readme.md +++ b/launchers/qt/readme.md @@ -21,7 +21,7 @@ Behavior of the HQ Launcher is as follows: * home location * `LauncherWindows` - wrapper for `QQuickWindow` that implements drag feature * `LoginRequest` - checks the login credentials the user typed in. -* `NSTask+NSTaskExecveAddtions` - Extension of NSTask for replacing Launcher process with interface client process +* `NSTask+NSTaskExecveAdditions` - Extension of NSTask for replacing Launcher process with interface client process * `PathUtils` - Helper class for getting relative paths for HQ Launcher * `SignupRequest` - Determines if the users request to signup for a new account succeeded based on the entered credentials * `Unzipper` - helper class for extracting zip files @@ -31,4 +31,4 @@ Behavior of the HQ Launcher is as follows: * `images/`- 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 + * `QML_FILE_FOR_UI_STATE` variable in `LauchherState` defines what QML files are used by the Laucnher. \ No newline at end of file From 60140a3aca0fe68e5a493a50e49cbc9dde5ad341 Mon Sep 17 00:00:00 2001 From: danteruiz Date: Mon, 25 Nov 2019 15:22:47 -0800 Subject: [PATCH 4/4] fix more typos --- launchers/qt/readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/launchers/qt/readme.md b/launchers/qt/readme.md index 917c647511..ce4e846172 100644 --- a/launchers/qt/readme.md +++ b/launchers/qt/readme.md @@ -1,9 +1,9 @@ # HQ Launcher Behavior of the HQ Launcher is as follows: * Update the HQ Launcher to the latest version -* Sign up and sign in is the user is not +* Sign up or sign in if is the user is not already signed in * Download the latest Interface client -* Launching the user in the current HQ domain +* Launch the user in the current HQ domain # directory structure @@ -31,4 +31,4 @@ Behavior of the HQ Launcher is as follows: * `images/`- Holds the images and icon that are used by the launcher * `qml/` * UI elements - * `QML_FILE_FOR_UI_STATE` variable in `LauchherState` defines what QML files are used by the Laucnher. \ No newline at end of file + * `QML_FILE_FOR_UI_STATE` variable in `LauncherState` defines what QML files are used by the Launcher. \ No newline at end of file