Peter M. Groen / openhantek

Commit 6f5146e71b24757ccd7a6ecef20b99fe243ec23e

Authored by David Gräff
Committed by GitHub
1 parent 8cb6bc18

Update readme.md 

Readme: Added more information for windows users
Inline Side-by-side
Showing 1 changed file with 28 additions and 9 deletions
readme.md
  View file @6f5146e
... ... @@ -6,9 +6,11 @@ Supported operating systems:
6 6 * MacOSX
7 7 * Windows¹
8 8  
9   -<img alt="Image of main window" width="350" src="doc/screenshot_mainwindow.png">
10   -<img alt="Image of main window" width="350" src="doc/screenshot_mainwindow_win.png">
11   -
  9 +<table><tr>
  10 + <td> <img alt="Image of main window on linux" width="100%" src="doc/screenshot_mainwindow.png"> </td>
  11 + <td> <img alt="Image of main window on Windows" width="100%" src="doc/screenshot_mainwindow_win.png"> </td>
  12 +</tr></table>
  13 +
12 14 Supported hantek devices:
13 15 * DSO2xxx Series
14 16 * DSO52xx Series
... ... @@ -61,17 +63,34 @@ Please adjust the path to Qt5. You can find the path with the command:
61 63  
62 64 ### Build on Windows
63 65  
64   -Run the **CMake GUI** program and select the source directory, build directory and your compiler. If your compiler is for example Visual Studio, cmake will generate a Visual Studio Project and solution file (\*.sln). Open the project and build it.
  66 +Run the **CMake GUI** program and select the source directory, build directory and your compiler. If your compiler is for example Visual Studio, cmake will generate a Visual Studio Project and solution file (\*.sln). Open the project and build it. If you use an IDE that has inbuild support for cmake projects like QtCreator, you can just open and build this project.
  67 +
  68 +## Windows: Install driver
  69 +
  70 +While we don't need an installed driver on linux and MacOS X, we do need one on Windows systems.
65 71  
66   -## Executing OpenHantek
  72 +* Make sure your original Hantek driver is uninstalled.
  73 +* Extract `cmake/winusb driver.zip` and customize the `libusb_device.inf` file for your device. The Vendor ID and Device ID as well as a unique GUID need to be entered like in the following example for a Hantek 6022BE.
  74 +* Physically plug (or replug) oscilloscope into PC's. From the Windows device manager update driver for your device and point to your modified libusb_device.inf.
67 75  
68   -* Make sure the firmware for your DSO has been uploaded to the device before starting OpenHantek. See the next section for further information.
  76 +````
  77 +; =====================================================
  78 +; ========= START USER CONFIGURABLE SECTION ===========
  79 +; =====================================================
69 80  
70   -* ¹:Install the WINUSB driver on Windows: Extract `cmake/winusb driver.zip` and customize the inf file for your device. The Vendor ID and Device ID as well as a unique GUID need to be entered.
  81 +DeviceName = "HantekDSO6022BE"
  82 +VendorID = "VID_04B5"
  83 +ProductID = "PID_6022"
  84 +DeviceClassGUID = "{78a1c341-4539-11d3-b88d-00c04fad5171}"
  85 +; Date MUST be in MM/DD/YYYY format
  86 +Date = "08/12/2017"
71 87  
72   -* Execute OpenHantek. On Windows, click the **OpenHantek.exe** file. On Linux/OSX on the command line in the build directory: `./bin/OpenHantek`
  88 +; =====================================================
  89 +; ========== END USER CONFIGURABLE SECTION ============
  90 +; =====================================================
  91 +````
73 92  
74   -## Firmware
  93 +## Firmware (Linux and MacOS X)
75 94 Your DSO does not store its firmware permanently -- the firmware has to be sent to the device each time it is connected. The `firmware` directory of this project contains the binary firmware extracted from Hantek's Windows drivers, and a udev rule to upload the firmware to the device automatically each time it is plugged in.
76 95  
77 96 * You need binutils-dev autoconf automake fxload
... ...