GUI Explanation - PDDStudio/polar-dashboard-upgrade-tool GitHub Wiki

##Explore the GUI This page is all about explaining the GUI and it's functionality and behavior (even though it should actually be self-explaining, but you never know).

###The Main UI

As soon as you open the application you'll see the application's main UI, which should look similar to the one below. (Note: this can be different in later releases, but you never know ¯\_(ツ)_/¯ )

Menu Explanation

  • Menu (Opens a Submenu)
  • Help & Usage (Which will bring you to this Wiki)
  • Check for Update (Which will check whether there's a new version of PUT available
  • About (Which will open an About Window)
  • Browse (Opens a FolderChooser-Dialog)

###PUT Update Information

PUT will always notify you when you're not running the latest version. You can either update PUT or skip the dialog message, this is up to you.

But it is highly recommended to always use the latest version

###Starting an Update

To upgrade a Polar-based project you have to open the FolderChooser-Dialog by pressing the Browse-Button and navigating to the destination of your Icon Pack.

→ Select the root folder of your Polar-based project, the FolderChooser-Dialog might look different on other Operation Systems

###Doing it right

If you've successfully selected the root folder of your Polar-based Project an Update Button should appear on the right bottom side:

→ The update Button gets visible after the Project has been selected

###Doing it wrong

The tool will automatically check whether the selected project is really based on Polar, in case you selected the wrong folder (or a non-based Polar project) a warning will appear.

This is more or less a hint, you could still try to upgrade your project anyways (at your own risk)

→ A warning will appear in case a non Polar based project is selected

###Starting the Update

Once you successfully selected your project's folder you can start with the update by simply pressing the Update button. The UI will keep you up to date with all important information while the update is in progress.

→ The GUI after starting the Update (Note: Polar will be replaced with your project's name)

→ The GUI will always keep you up to date with what it's doing

###Finishing the Update

As soon as the update is finished, you'll see an information dialog, confirming that your project is now updated with the latest Polar source.

→ The information dialog after the update is done

By pressing Okay the application will close itself and you're done with updating your project.