making requested changes

This commit is contained in:
danteruiz 2019-11-25 14:50:58 -08:00
parent d8ba0564b5
commit c08a18c517
2 changed files with 31 additions and 15 deletions

View file

@ -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.
If you wish to not use the compiled qml files, pass the `-DLAUNCHER_SOURCE_TREE_RESOURCES=On` argument to cmake.

View file

@ -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.
* `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.