Peter M. Groen / openhantek

Commit 0f3e1d63c4e87992686d57f0914ed1ffeb9c32c9

Authored by David Gräff
Committed by GitHub
1 parent e110bb60

Update readme.md (#153) 

Add features section to readme. Advice to use QtCreator on all platforms.
Inline Side-by-side
Showing 1 changed file with 23 additions and 7 deletions
readme.md
  View file @0f3e1d6
@@ -2,16 +2,28 @@ @@ -2,16 +2,28 @@
2 2
3 OpenHantek is a free software for Hantek and compatible (Voltcraft/Darkwire/Protek/Acetech) USB digital signal oscilloscopes. 3 OpenHantek is a free software for Hantek and compatible (Voltcraft/Darkwire/Protek/Acetech) USB digital signal oscilloscopes.
4 4
5 -It has started as an alternative to the official Hantek DSO software for Linux users. Nowadays it works under Microsoft Windows and Apple Mac OS as well.  
6 -  
7 <table><tr> 5 <table><tr>
8 <td> <img alt="Image of main window on linux" width="100%" src="docs/images/screenshot_mainwindow.png"> </td> 6 <td> <img alt="Image of main window on linux" width="100%" src="docs/images/screenshot_mainwindow.png"> </td>
9 <td> <img alt="Image of main window on Windows" width="100%" src="docs/images/screenshot_mainwindow_win.png"> </td> 7 <td> <img alt="Image of main window on Windows" width="100%" src="docs/images/screenshot_mainwindow_win.png"> </td>
10 </tr></table> 8 </tr></table>
11 9
12 -* Supported operating systems: Linux, MacOSX, Windows¹ 10 +* Supported operating systems: Linux, MacOSX, Windows¹, Android
13 * Supported devices: DSO2xxx Series, DSO52xx Series, 6022BE/BL 11 * Supported devices: DSO2xxx Series, DSO52xx Series, 6022BE/BL
14 12
  13 +## Features
  14 +
  15 +* Digital phosphor effect to notice even short spikes
  16 +* Voltage and Spectrum view for all device supported chanels
  17 +* Math channel with these modes: Ch1+Ch2, Ch1-Ch2
  18 +* Freely configurable colors
  19 +* Export to CSV, JPG, PNG or print the graphs
  20 +* Supports hardware and software triggered devices
  21 +* A zoom view with a freely selectable range
  22 +* All settings can be saved to a configuration file and loaded again
  23 +* Multiple instances with a different device each can be started
  24 +* The dock views on the main window can be customized by dragging them around and stacking them.
  25 + This allows a minimum window size of 640*480 for old workstation computers.
  26 +
15 ## Install prebuilt binary 27 ## Install prebuilt binary
16 Navigate to the [Releases](https://github.com/OpenHantek/openhantek/releases) page 28 Navigate to the [Releases](https://github.com/OpenHantek/openhantek/releases) page
17 29
@@ -21,14 +33,17 @@ You need the following software, to build OpenHantek from source: @@ -21,14 +33,17 @@ You need the following software, to build OpenHantek from source:
21 * [Qt 5.4+](https://www1.qt.io/download-open-source/) 33 * [Qt 5.4+](https://www1.qt.io/download-open-source/)
22 * [FFTW 3+ (prebuild files will be downloaded on windows)](http://www.fftw.org/) 34 * [FFTW 3+ (prebuild files will be downloaded on windows)](http://www.fftw.org/)
23 * libusb 1.x (prebuild files will be used on windows) 35 * libusb 1.x (prebuild files will be used on windows)
24 -  
25 -You need a OpenGL 3.x capable graphics card for OpenHantek. 36 +* A compiler that supports C++11
26 37
27 We have build instructions available for [Linux](docs/build.md#linux), [Apple MacOSX](docs/build.md#apple) and [Microsoft Windows](docs/build.md#windows). 38 We have build instructions available for [Linux](docs/build.md#linux), [Apple MacOSX](docs/build.md#apple) and [Microsoft Windows](docs/build.md#windows).
28 39
29 ## Run OpenHantek 40 ## Run OpenHantek
30 -Please be aware that you need USB access permissions. As seen on the [Microsoft Windows build instructions](docs/build.md#windows) page, you need a  
31 -special driver for Windows systems. On Linux, you need to copy the file `firmware/60-hantek.rules` to `/lib/udev/rules.d/` and replug your device. 41 +You need a OpenGL 3.0+ or OpenGL ES 2.0+ capable graphics hardware for OpenHantek.
  42 +
  43 +USB access for the device is required:
  44 +* As seen on the [Microsoft Windows build instructions](docs/build.md#windows) page, you need a
  45 +special driver for Windows systems.
  46 +* On Linux, you need to copy the file `firmware/60-hantek.rules` to `/lib/udev/rules.d/` and replug your device.
32 47
33 ## Specifications, Features and limitations 48 ## Specifications, Features and limitations
34 Please refer to the [Specifications, Features, Limitations](docs/limitations.md) page. 49 Please refer to the [Specifications, Features, Limitations](docs/limitations.md) page.
@@ -42,6 +57,7 @@ We welcome any reported Github Issue if you have a problem with this software. S @@ -42,6 +57,7 @@ We welcome any reported Github Issue if you have a problem with this software. S
42 (install clang-format. Use make target: `make format` or execute directly from the openhantek directory: `clang-format -style=file src/*`). 57 (install clang-format. Use make target: `make format` or execute directly from the openhantek directory: `clang-format -style=file src/*`).
43 - Open a [pull request][12] with a clear title and description. 58 - Open a [pull request][12] with a clear title and description.
44 - Read [Add a new device](docs/adddevice.md) if you want to know how to add a device. 59 - Read [Add a new device](docs/adddevice.md) if you want to know how to add a device.
  60 + - Do as a favour and use QtCreator as IDE on all platforms. It comes with CMake support, a decent compiler, and Qt out of the box.
45 61
46 [10]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request 62 [10]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
47 [11]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html 63 [11]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html