hantek_6022be.c: Drop unneeded debug code, random cruft.

[sigrok-firmware-fx2lafw.git] / README

diff --git a/README b/README
index be9931c240e89f77fdc5ad895b45bef7f294511f..548749fa908433e7f21d34b3982a8d7d6dd5bc0c 100644 (file)
--- a/README
+++ b/README
@@ -6,12 +6,9 @@ The sigrok project aims at creating a portable, cross-platform,
 Free/Libre/Open-Source signal analysis software suite that supports various
 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
 
-fx2lafw is a Free/Libre/Open-source firmware for logic analyzers based on
-the Cypress EZ-USB FX2(LP) chip.
-
-It is licensed under the terms of the GNU GPL (version 2 or later), and uses
-additional helper code (fx2lib), licensed under the GNU LGPL (version 2.1
-or later).
+sigrok-firmware-fx2lafw is a Free/Libre/Open-source firmware for logic
+analyzers based on the Cypress EZ-USB FX2(LP) chip, as well as the
+Hantek 6022BE USB oscilloscope.
 
 
 Status
@@ -37,7 +34,7 @@ Notes:
 
      $ apt-get install sdcc
 
-   This project has been tested to work with sdcc 2.9, 3.0, 3.1, and 3.2.
+   This project has been tested to work with sdcc 2.9 and 3.x.
 
  - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
    versions didn't have support for FX2 devices using this firmware.
@@ -69,6 +66,15 @@ See INSTALL or the following wiki page for more (OS-specific) instructions:
  http://sigrok.org/wiki/Building
 
 
+Pre-built firmware files
+------------------------
+
+There are also pre-built firmware files that can be used without having
+to build them from source. You can download those from:
+
+  http://sigrok.org/download/binary/sigrok-firmware-fx2lafw/
+
+
 fx2lib
 ------
 
@@ -84,13 +90,60 @@ The following files/directories were removed, as they're not needed
 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
 
 
-Mailing lists
--------------
+Hantek 6022BE firmware
+----------------------
+
+The Hantek 6022BE firmware was originally created by Jochen Hoenicke in
+05/2015 for the Hantek6022API github project by Robert Cope. Full credit
+for the implementation of the firmware goes to Jochen Hoenicke, thanks!
+
+Github project:
+
+  https://github.com/rpcope1/Hantek6022API
+
+We've incorporated the Hantek 6022BE firmware into the sigrok-firmware-fx2lafw
+repo/tarball for convenience of sigrok users. E.g. so that they can
+easily get it with the other fx2lafw firmware files from distro
+packages, the build scripts in sigrok-util automatically build/install
+it, the sigrok Windows installers automatically ship it, the sigrok
+Android APKs automatically ship it, etc. etc.
+
+The files we've integrated into fx2lafw from Hantek6022API were taken from
+the PyHT6022/HantekFirmware/custom directory of that repo, using the state
+as of 03/2016 (the files were last modified in 05/2015, though).
+
+The git hash of the last relevant commit there was:
+
+  0498e2ab239aabb1084c19e1e24faf56764b217e
 
-There are two mailing lists for sigrok/sigrok-firmware-fx2lafw:
+Files integrated into fx2lafw:
+
+ - hw/hantek-6022be/dscr.a51: Copied unmodified.
+
+ - hantek_6022be.c: This file was originally created by appending the
+   contents of the original device.c and fw.c together.
+
+
+Copyright and license
+---------------------
+
+sigrok-firmware-fx2lafw is licensed under the terms of the GNU General Public
+License (GPL), version 2 or later.
+
+It uses additional helper code (fx2lib, Hantek 6022BE firmware), licensed
+under the GNU LGPL (version 2.1 or later).
+
+While some individual source code files are licensed under the LGPLv2.1+, and
+some files are licensed under the GPLv2+, this doesn't change the fact that
+the firmware as a whole is licensed under the terms of the GPLv2+.
+
+Please see the individual source files for the full list of copyright holders.
+
+
+Mailing list
+------------
 
  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 
 
 IRC