diff --git a/readme.md b/readme.md index 84f7feb..a7deb58 100644 --- a/readme.md +++ b/readme.md @@ -12,6 +12,7 @@ Supported operating systems: Supported hantek devices: * DSO2xxx Series * DSO52xx Series +* 6022BE/BL ## Install prebuilt binary Navigate to the [Releases](https://github.com/OpenHantek/openhantek/releases) page @@ -23,30 +24,54 @@ You need the following packages, to build OpenHantek from source: * FFTW 3+ (prebuild files will be downloaded on windows) * libusb 1.x (prebuild files will be used on windows) +You need a OpenGL 3.x capable graphics card for OpenHantek. + +### Install requirements on Linux For debian based systems (Ubuntu, Mint) install named requirements like this: > apt-get install g++ cmake qttools5-dev qttools5-dev-tools libfftw3-dev binutils-dev libusb-1.0-0-dev For rpm based distributions (Fedora) use this command: > dnf install cmake gcc-c++ qt5-qtbase-gui qt5-qttools-devel qt5-qttranslations fftw-devel binutils-devel libusb-devel +### Install requirements on OSX For MacOSX use homebrew > brew update
> brew install libusb fftw qt5; -After you've installed the requirements either run **cmake-gui** or run the following commands inside the directory of this package: +### Build on Linux +After you've installed the requirements run the following commands inside the directory of this package: > mkdir build
> cd build
> cmake ../
-> make -j4 (for 4 concurrent compile jobs)
-> make install (optional, for installing only) +> make -j + +Optionally install the program including a desktop icon: + +> sudo make install + +### Build on OSX +After you've installed the requirements run the following commands inside the directory of this package: +> mkdir build
+> cd build
+> cmake ../ -DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.7.0
+> make -j -For MacOSX, the cmake command in the previous command list must include the directory where Qt5 is installed. Qt5 is installed in a directory with the same name of its version: +Please adjust the path to Qt5. You can find the path with the command: > brew info qt5 -For example, if brew showed 5.7.0, the cmake command should be: -> cmake ../ -DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.7.0 -You can specify an install prefix when running cmake: -> cmake -DCMAKE_INSTALL_PREFIX=/usr +### Build on Windows + +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. + +## Executing OpenHantek + +* Linux/OSX: Add your current user to the **plugdev** group for access to USB devices: + +> usermod -a -G plugdev {user id} + +* Make sure the firmware for your DSO has been uploaded to the device before starting OpenHantek. See the next section for further information. + +* Execute OpenHantek. On Windows, click the **OpenHantek.exe** file. On Linux/OSX on the command line in the build directory: `./bin/OpenHantek` ## Firmware 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. @@ -65,30 +90,27 @@ Your DSO does not store its firmware permanently -- the firmware has to be sent > apt-get install fxload -* Add your current user to the **plugdev** group. - -> usermod -a -G plugdev {user id} - -## For 6022BE +## 6022BE You can adjust samplerate and use software triggering for 6022BE. - Support 48, 24, 16, 8, 4, 2, 1 M and 500, 200, 100 k Hz samplerates with modded firmware by [jhoenicke](https://github.com/rpcope1/Hantek6022API) - Support software trigger by detecting rising or falling edge of signal. Use software trigger item on the trigger menu. For trigger level, adjust left arrow on the right-side of the graph. - - Note that I dropped first 1000 samples due to unstable/unusual reading. + - Note that the first few thousand samples are dropped due to unstable/unusual reading. ## Contribute Please use Github Issues to report any problems or enhancements or send us pull requests. Some random notes: - Read [how to properly contribute to open source projects on GitHub][10]. - - Use a topic branch to easily amend a pull request later, if necessary. + - Create a separate branch other than *master* to easily amend changes to a pull request later, if necessary. - Write [good commit messages][11]. - - Squash commits on the topic branch before opening a pull request. + - [Squash commits[][14] on the topic branch before opening a pull request. - Use the same [coding style and spacing][13] (install clang-format and use it in the root directory: `clang-format -style=llvm openhantek/src/*`). - - Open a [pull request][12] that relates to but one subject with a clear title and description + - Open a [pull request][12] with a clear title and description [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 [12]: https://help.github.com/articles/using-pull-requests [13]: http://llvm.org/docs/CodingStandards.html +[14]: https://github.com/ginatrapani/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit ## Other open source software * [SigRok](www.sigrok.org)