minor build system tweaks; doc update

Signed-off-by: Martin <Ho-Ro@users.noreply.github.com>

Author: Ho-Ro

.github/workflows/build_check.yml

@@ -1,12 +1,16 @@
 name: Build_Check
 # check if OH6022 builds on some recent operating systems
-# deploy Ubuntu / macOS binaries (instead of appveyor)
+# deploy Ubuntu / macOS / Windows binaries
 
 on: [push]
 
+
 env:
   # CMake build type (Release, Debug, RelWithDebInfo, etc.)
   BUILD_TYPE: Release
+  # MSVC specific, needed by packaging etc.
+  VCINSTALLDIR: "C:/Program Files (x86)/Microsoft Visual Studio/2019/Enterprise/VC"
+
 
 
 jobs:
@@ -60,7 +64,7 @@ jobs:
       uses: actions/upload-artifact@v2
       with:
         name: openhantek_linux_amd64_${{github.run_number}}
-        path: ${{github.workspace}}/build/packages/
+        path: ${{github.workspace}}/build/packages/*
 
 
     # --- macOS steps ---
@@ -89,23 +93,23 @@ jobs:
         export Qt5_DIR=$(brew --prefix qt5);
         export PATH=${Qt5_DIR}/bin:${PATH};
         cd openhantek ; macdeployqt OpenHantek.app -always-overwrite -verbose=1;
-        python ../../utils/macdeployqtfix/macdeployqtfix.py 
+        python ../../utils/macdeployqtfix/macdeployqtfix.py
         --quiet OpenHantek.app/Contents/MacOS/OpenHantek ${Qt5_DIR};
-        create-dmg --volname OpenHantek --volicon ../../openhantek/res/images/openhantek.icns 
-        --window-pos 200 120 --window-size 800 400 --icon-size 100 --icon "OpenHantek.app" 200 190 
-        --skip-jenkins --hide-extension "OpenHantek.app" --app-drop-link 600 185 
+        create-dmg --volname OpenHantek --volicon ../../openhantek/res/images/openhantek.icns
+        --window-pos 200 120 --window-size 800 400 --icon-size 100 --icon "OpenHantek.app" 200 190
+        --skip-jenkins --hide-extension "OpenHantek.app" --app-drop-link 600 185
         --eula ../../LICENSE OpenHantek.dmg OpenHantek.app;
         cd ..;
         else true;
         fi;
-        if test -d openhantek/OpenHantek.app; then 
+        if test -d openhantek/OpenHantek.app; then
         cd openhantek ; sudo tar -czf ../packages/openhantek_*_osx_*.tar.gz OpenHantek.app;
         if test -f OpenHantek.dmg; then
         sudo mv OpenHantek.dmg ../packages/$(basename ../packages/openhantek_*_osx_*.tar.gz .tar.gz).dmg;
         fi;
         cd ..;
         ls -l packages;
-        else true; 
+        else true;
         fi
 
 
@@ -114,7 +118,7 @@ jobs:
       uses: actions/upload-artifact@v2
       with:
         name: openhantek_osx_x86_64_${{github.run_number}}
-        path: ${{github.workspace}}/build/packages/*.dmg
+        path: ${{github.workspace}}/build/packages/*
 
 
     # --- Windows steps ---
@@ -124,11 +128,11 @@ jobs:
       uses: jurplel/install-qt-action@v2
 
 
-    - name: Install Windows Build Requirements
+    - name: Setup Windows Build
       if: startsWith(matrix.os, 'windows')
       run:
         md build &
-        call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat" &
+        call "%VCINSTALLDIR%/Auxiliary/Build/vcvars64.bat" &
         cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_PREFIX_PATH=%Qt5_DIR% -DCMAKE_BUILD_TYPE=Release -Bbuild
 
 
@@ -162,6 +166,7 @@ jobs:
       if: startsWith(github.ref, 'refs/tags/')
       uses: softprops/action-gh-release@v1
       with:
+        prerelease: true
         files: ${{github.workspace}}/build/packages/*
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CMakeLists.txt

@@ -56,24 +56,15 @@ add_subdirectory(openhantek)
 
 if (WIN32)
     install(
-	FILES CHANGELOG LICENSE README
-	DESTINATION "."
+        FILES CHANGELOG LICENSE README
+        DESTINATION "."
     )
 endif()
 
 # Add auxiliary files to the project, so that these files appear in VisualStudio/QtCreator
 file(GLOB_RECURSE MDFILES "docs/*.md" "openhantek/*.md")
 add_custom_target(
     readme
-    SOURCES CHANGELOG LICENSE README readme.md ${MDFILES}
+    SOURCES CHANGELOG LICENSE README README.md ${MDFILES}
 )
 
-# Add "doc" target to build the documentation.
-#find_package(Doxygen QUIET)
-#if (DOXYGEN_FOUND)
-#    add_custom_target(
-#	doc
-#        COMMAND "${CMAKE_COMMAND} -E remove_directory html"
-#        COMMAND "${DOXYGEN_EXECUTABLE} Doxyfile" WORKING_DIRECTORY "${CMAKE_CURRENT_LIST_DIR}"
-#    )
-#endif()

readme.md README.md

@@ -1,16 +1,12 @@
 # OpenHantek6022
 [![Stability: Active](https://masterminds.github.io/stability/active.svg)](https://masterminds.github.io/stability/active.html)
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/OpenHantek/OpenHantek6022)][release]
-[![GitHub Release Date](https://img.shields.io/github/release-date/OpenHantek/OpenHantek6022?color=blue)][release]
-[![GitHub commits since latest release](https://img.shields.io/github/commits-since/OpenHantek/OpenHantek6022/latest?color=brightgreen)][commits]
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/OpenHantek/OpenHantek6022)](https://github.com/OpenHantek/OpenHantek6022/releases)
+[![GitHub Release Date](https://img.shields.io/github/release-date/OpenHantek/OpenHantek6022?color=blue)](https://github.com/OpenHantek/OpenHantek6022/releases)
+[![GitHub commits since latest release](https://img.shields.io/github/commits-since/OpenHantek/OpenHantek6022/latest?color=blue)](https://github.com/OpenHantek/OpenHantek6022/commits/master)
 
 [![GitHub CI](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml/badge.svg)](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml)
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/OpenHantek/openhantek6022?svg=true)](https://ci.appveyor.com/project/Ho-Ro/openhantek6022)
 [![CodeFactor](https://www.codefactor.io/repository/github/openhantek/openhantek6022/badge)](https://www.codefactor.io/repository/github/openhantek/openhantek6022)
 
-[release]: https://github.com/OpenHantek/OpenHantek6022/releases
-[commits]: https://github.com/OpenHantek/OpenHantek6022/commits/master
-
 OpenHantek6022 is a free software for **Hantek DSO6022** USB digital signal oscilloscopes that is actively developed on
 [github.com/OpenHantek/OpenHantek6022](https://github.com/OpenHantek/OpenHantek6022) - but only for Hantek 6022BE/BL and compatible scopes (Voltcraft, Darkwire, Protek, Acetech, etc.).
 
@@ -20,18 +16,34 @@ but David [stopped maintaining](https://github.com/OpenHantek/openhantek/issues/
 
 <p><img alt="Image of main window on linux" width="100%" src="docs/images/screenshot_mainwindow.png"></p>
 
+#### Content
+* [About OpenHantek6022](#about-openhantek6022)
+* [Features](#features)
+* [AC coupling](#ac-coupling)
+* [Continous Integration](#continous-integration)
+* [Building OpenHantek6022 from source](#building-openhantek6022-from-source)
+* [Install prebuilt binary packages](#install-prebuilt-binary-packages)
+* [Run OpenHantek6022](#run-openhantek6022)
+  + [Windows USB access](#windows-usb-access)
+* [Important!](#important-)
+* [Specifications, features, limitations and developer documentation](#specifications--features--limitations-and-developer-documentation)
+* [Contribute](#contribute)
+* [Other DSO open source software](#other-dso-open-source-software)
+* [Other related software](#other-related-software)
+
+## About OpenHantek6022
 * Supported devices:
- * Hantek 6022BE and 6022BL as well as compatible scopes (e.g. Voltcraft DSO-2020).
- * SainSmart DDS120 (thx [msiegert](https://github.com/msiegert)) - this device has a different analog front end
+  - Hantek 6022BE and 6022BL as well as compatible scopes (e.g. Voltcraft DSO-2020).
+  - SainSmart DDS120 (thx [msiegert](https://github.com/msiegert)) - this device has a different analog front end
  and uses the [slightly improved sigrok firmware](https://github.com/Ho-Ro/sigrok-firmware-fx2lafw), which has [some limitations](https://sigrok.org/wiki/SainSmart_DDS120/Info#Open-source_firmware_details)
  compared to the Hantek scopes (see [#69](https://github.com/OpenHantek/OpenHantek6022/issues/69#issuecomment-607341694)).
+
 * Demo mode is provided by the `-d` or `--demoMode` command line option.
 * Fully supported operating system: Linux; developed under debian stable for amd64 architecture.
 * Raspberry Pi packages (raspbian stable) are available on the [Releases](https://github.com/OpenHantek/OpenHantek6022/releases) page, check this [setup requirement](docs/build.md#raspberrypi).
 * Compiles under FreeBSD (packaging / installation: work in progress, thx [tspspi](https://github.com/tspspi)).
 * Other operating systems builds: [Windows](docs/images/screenshot_mainwindow_win.png) (mostly untested) & macOS (completely untested).
-
- **No support for non-Linux related issues unless a volunteer steps in!**
+  **No support for non-Linux related issues unless a volunteer steps in!**
 * Uses [free open source firmware](https://github.com/Ho-Ro/Hantek6022API), no longer dependent on nonfree Hantek firmware.
 * Extensive [User Manual](docs/OpenHantek6022_User_Manual.pdf) with technical specs and schematics.
 
@@ -67,15 +79,18 @@ but David [stopped maintaining](https://github.com/OpenHantek/openhantek/issues/
 * French, German, Russian and Spanish localisation complete, Italian and Portuguese translation ongoing.
 
 ## AC coupling
-* A [little HW modification](docs/HANTEK6022_AC_Modification.pdf) adds AC coupling. OpenHantek6022 supports this feature since v2.17-rc5 / FW0204.
+A [little HW modification](docs/HANTEK6022_AC_Modification.pdf) adds AC coupling. OpenHantek6022 supports this feature since v2.17-rc5 / FW0204.
 
 ## Continous Integration
 Every commit triggers a workflow on
-[GitHub Actions](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/ubuntu_check.yml)
-that checks the build on different Ubuntu LTS versions (curently 20.04 and 18.04)
-and a workflow on [appveyor](https://ci.appveyor.com/project/Ho-Ro/openhantek6022)
-that builds and packages OpenHantek6022 for Linux (Ubuntu), macOS and Windows.
-Status badges on top of this page show the build status.
+[GitHub Actions](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml)
+that builds and packages OpenHantek6022 for:
+* Linux (Ubuntu-18.04)
+* macOS (Catalina 10.15)
+* Windows (MSVS-2019)
+
+[![GitHub CI](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml/badge.svg)](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml)
+This status badge here (and on top of this page) show the build status.
 
 ## Building OpenHantek6022 from source
 The preferred way to run OpenHantek is to build it from source on your system,

cmake/CPackInfos.cmake

@@ -1,7 +1,7 @@
-# This file configures CPack. 
-# A tgz, deb and rpm file is created for linux (tgz and deb tested on debian stretch and buster).
-# A tgz file is created for osx (not tested).
-# A zip file and an NSIS Installer exe is created on windows (not tested).
+# This file configures CPack.
+# A tgz, deb and rpm file is created for Linux (tgz and deb tested on debian stretch and buster).
+# A tar.gz and dmg file is created for macOS (not tested).
+# A zip file is created on Windows (not tested).
 
 find_package(Git QUIET)
 
@@ -140,7 +140,7 @@ set(CPACK_PACKAGE_CONTACT "contact@openhantek.org")
 set(CPACK_PACKAGE_VENDOR "OpenHantek Community")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Digital oscilloscope software for Hantek DSO6022 USB hardware")
 set(CPACK_PACKAGE_DESCRIPTION "OpenHantek is an oscilloscope software for\nVoltcraft/Darkwire/Protek/Acetech/Hantek USB devices")
-set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/readme.md")
+set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
 if (EXISTS "${CMAKE_SOURCE_DIR}/LICENSE")
     set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
 endif()

openhantek/src/OH_BUILD.h

@@ -1,2 +1,2 @@
 // Do not edit, will be re-created at each commit!
-#define OH_BUILD "20210411 build 0"
+#define OH_BUILD "20210412 build 0"