Add + Updated doc for installer/uninstaller

Author: mmeisser

Assets/Readme.md

@@ -15,15 +15,16 @@ Here are descriptions of the different buttons and inputs available with Logitec
 
 # Setting up VR Ink
 To ensure VR Ink works in applications and appears correctly in the SteamVR shell and status window, an initial installation is required.
+>Note: if you need a special standalone version, look [here](../Documentation/Driver/installer.md).
 
 ## 1. Install the Driver
 1. Download the latest [logitech VR Ink Driver](https://store.steampowered.com/app/1068300/Logitech_VR_Ink_Driver/) from the **Steam Store**.<br>
 [<img src="../Documentation/Images/SteamVR/steamstore_page_small.png" width="500" >](../Documentation/Images/SteamVR/steamstore_page_small.png)<br><br>
 2. After successful install the SteamVR status window should look like the one below: you'll note an additional icon (greyed out) for the Logitech VR Ink driver. <br>
 [<img src="../Documentation/Images/SteamVR/steamvr_dash_after_install.png">]()<br><br>
-Some verifications before you move on:
-   * Make sure your **HMD is connected** and turned on.
-   * Verify that SteamVR is **NOT in Safe mode**, as the driver won't be loaded, if that is the case **restart SteamVR**.<br><br>
+>Some verifications before you move on:
+>   * Make sure your **HMD is connected** and turned on.
+>   * Verify that SteamVR is **NOT in Safe mode**, as the driver won't be loaded, if that is the case **restart SteamVR**.<br><br>
 3. Then **pair your VR Ink** following the steps described below.
 
 
@@ -58,9 +59,9 @@ Some verifications before you move on:
 
 ## 3. Using VR Ink
 * Now, If you wear the HMD you should see the VR Ink model in the SteamVR Shell: try to move it !
-* You can bring up the **Logitech VR Ink settings UI** either from clicking on its icon in the **taskbar** or from the windows **tray**:<br>[<img src="../Documentation/Images/Driver/task_bar_icon.png" width="167" alt="Task Bar">]() [<img src="../Documentation/Images/Driver/vrink driver tray.png" width="214" alt="Windows tray">]()<br>
+* You can bring up the **Logitech VR Ink settings UI** either from clicking on its icon in the **taskbar** or from the windows **tray**:<br>[<img src="../Documentation/Images/Driver/task_bar_icon.png" width="167" alt="Unity Integration">]() [<img src="../Documentation/Images/Driver/vrink driver tray.png" width="214" alt="Unity Integration">]()<br>
 * The UI allows you to **verify the status** of your stylus as well as **select specific pressure sensitivity** for the PRIMARY, TIP and GRIP force sensing buttons.<br>
-[<img src="../Documentation/Images/Driver/driver_ui.png" width="500" alt="Driver UI">]()
+[<img src="../Documentation/Images/Driver/driver_ui.png" width="500" alt="Unity Integration">]()
 
 * After your VR Ink is set up, we highly recommend that you check out our Demo App:<br>
 [<img src="../Documentation/Images/LandingPage/DemoExperience.png" width="214" alt="Demo Experience">](../Documentation/DemoExperience)

Documentation/Driver/Readme.md

@@ -1,16 +1,23 @@
 # Logitech VR Ink Driver
 
-The Driver will allow you to customize VR Ink. You can define force response curves for the tip and primary button as well as the grip activation threshold.
+The Driver will allow you to customize VR Ink. You can **define force response curves** for the tip and primary button as well as the **grip activation threshold**.
 
-## In Development
+> **Note for Developers:**<br>
+For The first versions of VR Ink, we issue a driver that listens to the physical device and advertises a virtual device. Because of this approach there is a delay of around 10ms on input and pose.
 
-For early versions of VR Ink, we issue a driver that listens to the physical device and advertises a virtual device. Like a physical device, the virtual device registers as either the Left or Right hand in OpenVR. Because of this approach there is a delay of around 10ms on input and pose.
+>In the future the virtual device will be removed as the features exposed by the virtual device software will be managed directly into the device's firmware. **If your application can use our virtual device now, it will be 100% compatible with the future iterations of VR Ink.**
 
-In the future the virtual device will disappear and the features exposed by the virtual device software will be managed directly into the device's firmware. **If your application can use our virtual device now, it will be 100% compatible with the future iterations of VR Ink.**
+<br>
 
 ## Installation
 
-Please check out our [guide on setting up VR Ink](../../Assets) for instructions on installing the Driver. The Driver files can be found on the [releases page](https://github.com/Logitech/vr_ink_sdk/releases).
+### Recommended 
+You simply install it from the [Steam store page](https://store.steampowered.com/app/1068300/Logitech_VR_Ink_Driver/).<br> -> Please check out our [guide on setting up VR Ink](../../Assets) for detailed instructions. 
+
+### Manual install (for standalone setups)
+If you need to run a **standalone version os SteamVR**:<br> -> You can use the manual installer: See instructions [here](./installer.md).
+
+<br>
 
 ## How to Use
 

Documentation/Driver/installer.md

@@ -0,0 +1,61 @@
+# VR Ink Driver Manual Installer 
+
+**WARNING**:
+> This manual installer/uninstaller is only intended to be used if you cannot use the steamStore or cannot download the installer from it.
+
+If you are running a standalone version of SteamVR then you must install the driver manually using our installer/uninstaller.
+
+<br>
+
+## Supported versions
+
+Here is the list of supported versions for the manual installer:
+
+|SteamVR version| Driver version| Note |
+|---|---|---|
+|**1.6.x**|v 2.24|
+|**1.9.x**|v 2.26.2|
+|**1.10.x**|v 2.30| latest
+
+<br>
+
+## Features
+The Installer/Uninstaller is able to:
+- install the selected driver version in `SteamVR/drivers/logitech_stylus`*.
+- register the `SteamVR/drivers/logitech_stylus` path into vrpathreg.
+- remove any previous installation of `logitech_stylus` in either the `SteamVR/drivers/` or `Steam/steamapps/common/` folders.
+- remove ANY path that mentions `logitech_stylus`in vrpathreg.
+
+> note* : this is a safe folder for installing drivers on a standalone SteamVR install.
+
+<br>
+
+## Instructions
+
+- go to the [releases page](https://github.com/Logitech/vr_ink_sdk/releases) and fetch the manual installer/uninstaller zip file.
+- unzip it to a location of your choice.
+- run the `vrink_manual_installer.exe` <br><br>
+![VR Ink Status](./../Images/Driver/vrink_manual_installer_1.png)
+- RECOMMENDED: if you think you've installed a previous version of our driver, it's better to start by **uninstalling** it first, by choosing option `1`
+- then select your option `2,3,4`, depending on the SteamVR version that you have.
+- Follow the instructions on the console.
+- in case you are asked a question, you can either choose `y` or `yes` to agree or simply **hit ENTER (or any key) to proceed**.
+
+
+<br>
+
+## Examples
+
+Here is an example of an install:
+![VR Ink Status](./../Images/Driver/vrink_manual_installer_2.png)
+
+
+Here is the example of an uninstall:
+![VR Ink Status](./../Images/Driver/vrink_manual_installer_3.png)
+
+<br>
+
+## Troubleshooting
+
+If you experience any problem with your VR Ink device, have a look at the [FAQ section](./../FAQ/Readme.md).
+If this does not solve your problem you can contact us at [vrinksupport@logitech.com](mailto:vrinksupport@logitech.com).