Commit 8cc3781c85682dc5dc70c5ffa738811b08400baf
1 parent
4b9821cf
Update and rename README to readme.md
Update readme file. Merge mainpage.dox and INSTALL content: Doxygen can handle markdown files fine even as main page.
Showing
2 changed files
with
66 additions
and
1 deletions
openhantek/README deleted
openhantek/readme.md
0 → 100644
| 1 | +# OpenHantek | |
| 2 | +OpenHantek is a free software for Hantek (Voltcraft/Darkwire/Protek/Acetech) USB digital storage oscilloscopes based on HantekDSO and has started as an alternative to the official Hantek DSO software for Linux users. | |
| 3 | + | |
| 4 | +Tested models so far: | |
| 5 | +* DSO-2090 | |
| 6 | + | |
| 7 | +Supported operating systems: | |
| 8 | +* Linux | |
| 9 | +* MacOSX (The lack of udev requires you to load the firmware by hand for now) | |
| 10 | + | |
| 11 | +## Building OpenHantek from source | |
| 12 | +You need the following packages, to build OpenHantek from source: | |
| 13 | +* Qt 5+ | |
| 14 | +* FFTW 3+ | |
| 15 | +* libusb 1.x | |
| 16 | + | |
| 17 | +For debian based systems (Ubuntu, Mint) install named requirements like this: | |
| 18 | +> apt-get install libqt4-dev libfftw3-dev | |
| 19 | + | |
| 20 | +For rpm based distributions (Fedora) use this command: | |
| 21 | +> dnf install qt5-qtbase-gui | |
| 22 | + | |
| 23 | +After you've installed the requirements run the following commands inside the directory of this package: | |
| 24 | +> qmake <br> | |
| 25 | +> make <br> | |
| 26 | +> make install | |
| 27 | + | |
| 28 | +You can specify a prefix when running qmake: | |
| 29 | +> qmake PREFIX=/usr | |
| 30 | + | |
| 31 | +## Firmware | |
| 32 | +Your DSO does not store its firmware permanently and have to be send to the device each time it is connected. Because of copyright reasons we cannot ship the firmware with this software. You have to extract the firmware using dsoextractfw and add some rules to udev: | |
| 33 | + | |
| 34 | +### Getting the Windows drivers | |
| 35 | +Before using OpenHantek you have to extract the firmware from the official Windows drivers. You can get them from the <a href="http://www.hantek.ru/download.html">Hantek website</a> or automatically download them with the script _fwget.sh_. | |
| 36 | + | |
| 37 | +### The firmware extraction tool | |
| 38 | +Install libbfd (Ubuntu) / binutils (Fedora) and build the tool by typing: | |
| 39 | +> make | |
| 40 | + | |
| 41 | +After building it, you can just run the fwget.sh script inside the openhantek-extractfw directory: | |
| 42 | +> sudo ./fwget.sh /usr/local/share/hantek/ | |
| 43 | + | |
| 44 | +You can also do it manually by placing the DSO*1.SYS file into the same directory and running the built binary: | |
| 45 | +> ./openhantek-extractfw <driver file> | |
| 46 | + | |
| 47 | +This should create two .hex files that should be placed into /usr/local/share/hantek/. | |
| 48 | + | |
| 49 | +### Installing the firmware | |
| 50 | +* Copy the 90-hantek.rules file to /etc/udev/rules.d/. | |
| 51 | +* install fxload (fxload is a program which downloads firmware to USB devices based on | |
| 52 | + AnchorChips EZ-USB, Cypress EZ-USB FX, or Cypress EZ-USB FX2 microcontrollers.) | |
| 53 | +* Add your current user to the **plugdev** group. | |
| 54 | + | |
| 55 | +## Contribute | |
| 56 | +Please use Github Issues to report any problems or enhancements or send us pull requests. Some random notes: | |
| 57 | + - Read [how to properly contribute to open source projects on GitHub][10]. | |
| 58 | + - Use a topic branch to easily amend a pull request later, if necessary. | |
| 59 | + - Write [good commit messages][11]. | |
| 60 | + - Squash commits on the topic branch before opening a pull request. | |
| 61 | + - Use the same coding style and spacing. | |
| 62 | + - Open a [pull request][12] that relates to but one subject with a clear title and description | |
| 63 | + | |
| 64 | +[10]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request | |
| 65 | +[11]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | |
| 66 | +[12]: https://help.github.com/articles/using-pull-requests | ... | ... |