diff --git a/readme.md b/readme.md index 063a22c..44ce3c5 100644 --- a/readme.md +++ b/readme.md @@ -2,16 +2,28 @@ OpenHantek is a free software for Hantek and compatible (Voltcraft/Darkwire/Protek/Acetech) USB digital signal oscilloscopes. -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. -
Image of main window on linux Image of main window on Windows
-* Supported operating systems: Linux, MacOSX, Windows¹ +* Supported operating systems: Linux, MacOSX, Windows¹, Android * Supported devices: DSO2xxx Series, DSO52xx Series, 6022BE/BL +## Features + +* Digital phosphor effect to notice even short spikes +* Voltage and Spectrum view for all device supported chanels +* Math channel with these modes: Ch1+Ch2, Ch1-Ch2 +* Freely configurable colors +* Export to CSV, JPG, PNG or print the graphs +* Supports hardware and software triggered devices +* A zoom view with a freely selectable range +* All settings can be saved to a configuration file and loaded again +* Multiple instances with a different device each can be started +* The dock views on the main window can be customized by dragging them around and stacking them. + This allows a minimum window size of 640*480 for old workstation computers. + ## Install prebuilt binary Navigate to the [Releases](https://github.com/OpenHantek/openhantek/releases) page @@ -21,14 +33,17 @@ You need the following software, to build OpenHantek from source: * [Qt 5.4+](https://www1.qt.io/download-open-source/) * [FFTW 3+ (prebuild files will be downloaded on windows)](http://www.fftw.org/) * libusb 1.x (prebuild files will be used on windows) - -You need a OpenGL 3.x capable graphics card for OpenHantek. +* A compiler that supports C++11 We have build instructions available for [Linux](docs/build.md#linux), [Apple MacOSX](docs/build.md#apple) and [Microsoft Windows](docs/build.md#windows). ## Run OpenHantek -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 -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. +You need a OpenGL 3.0+ or OpenGL ES 2.0+ capable graphics hardware for OpenHantek. + +USB access for the device is required: +* As seen on the [Microsoft Windows build instructions](docs/build.md#windows) page, you need a +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. ## Specifications, Features and limitations 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 (install clang-format. Use make target: `make format` or execute directly from the openhantek directory: `clang-format -style=file src/*`). - Open a [pull request][12] with a clear title and description. - Read [Add a new device](docs/adddevice.md) if you want to know how to add a device. + - 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. [10]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request [11]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html