Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MolotovCherry authored Sep 24, 2023
1 parent 1abf052 commit af9e4c9
Showing 1 changed file with 16 additions and 22 deletions.
38 changes: 16 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ It has many uses, such as:

Support: Windows 10 x64 +

_Note about downloads:
Chrome and Windows likes to vet software by amount of downloads. If you receive a download warning, or a smartscreen warning when you try to run it, this is because of Chrome/Windows respectively, not the software. If for any reason you are unsure, the source code is in the repo, and you can build it yourself from scratch using the [build instructions](https://github.com/MolotovCherry/virtual-display-rs#how-to-build)._

## Features
- Multiple monitors (up to 10)
- Multiple resolutions per monitor
Expand All @@ -27,27 +24,19 @@ https://github.com/MolotovCherry/virtual-display-rs/assets/13651622/4a244e40-65d
- Go to the [releases](https://github.com/MolotovCherry/virtual-display-rs/releases) section for the latest driver.
- Download (you may receive a warning, just press accept)
- Install certificate (see below section)
- Open `Device Manager`
- - Click on any item
- Click on `Action` menu item -> `Add legacy hardware` -> `Next`
- Click `Install the hardware that I manually select from a list (Advanced)`
- Click `Next` (`Show All Devices` will be selected)
- Click `Have Disk`
- Browse to the location of the folder, press `Ok`, and keep clicking the `Next` buttons
- Run the msi installer

_Note about driver install:
If you're getting an error about an unverified driver during install, it's either because the provided certificate isn't installed, or was installed incorrectly. You can also just install it anyways and it should still work._

### Installing the certificate
The certificate needs installation for Windows to accept the driver
- In your downloaded zip, double click on the file `DriverCertificate.cer`
- A window will popup with a `Install Certificate` button (click it)
- Select `Local Machine`
- Select `Place All Certificates in the following store`, click `Browse` and select `Trusted Root Certification Authorities`
- Cick `Next` and `Finish`
- In your downloaded zip, there is a file `DriverCertificate.cer` and `install-cert.bat`
- Open a cmd window as admin and run `install-cert.bat`

# Updating
- Open `Device Manager`
- Under the `Display` section, find the `Virtual Display` driver and double click
- Click the `Driver` tab and the `Update Driver` button
- Click `Browse my computer for drivers`, browse for the right location, and click `Next`
- Download the new release
- Install the msi package

# Using the app
Please see the [wiki](https://github.com/MolotovCherry/virtual-display-rs/wiki/Virtual-Display-Driver-Control) for instructions on using the app.
Expand All @@ -57,11 +46,16 @@ Please see the [wiki](https://github.com/MolotovCherry/virtual-display-rs/wiki/V
- Select and install the `Desktop development with C++` workload as well as Windows SDK
- Install the [WDK](https://learn.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk)
- Install [`cargo-make`](https://github.com/sagiegurari/cargo-make) if you don't have it
- You can build it with `cargo make -p dev build` (debug) or `cargo make -p prod build` (release)
- Install [`cargo-target-dir`](https://github.com/MolotovCherry/cargo-target-dir)
- You can build it with `cargo make build` (debug) or `cargo make -p prod build` (release), and check the `target/output` directory for all the files
- ... Or, fork my project and build it with github actions

### Debugging
To see panic messages and other information, download [DebugViewPP](https://github.com/CobaltFusion/DebugViewPP), run it, click on `Log`->`Capture Global Win32` (note, this requires DebugViewPP be run with admin permissions)
### Debugging or Reporting Crashes
If you want to debug a problem or need to report a crash, follow the below instructions:

All messages from the driver are logged in the Windows Event Viewer. Open the Event Viewer, go to `Windows Logs` -> `Application`, and you will see logs for the driver under the source name "VirtualDisplayDriver".

If you want to make them easier to see, right click on `Custom Views`, click `Create Custom View...`, select `By source`, find and select `VirtualDisplayDriver` in the list, then press `Ok`, type in `VirtualDisplayDriver` for the name, and press `Ok`. You should now see any log messages under the `Custom Views` section for `VirtualDisplayDriver`

# Contributions
All contributions are welcome! If you have any questions, feel free to post in the project [Discussion](https://github.com/MolotovCherry/virtual-display-rs/discussions) section

0 comments on commit af9e4c9

Please sign in to comment.