]> sigrok.org Git - sigrok-meter.git/blobdiff - README
doc: update IRC reference to Libera.Chat
[sigrok-meter.git] / README
diff --git a/README b/README
index 7ee6cb772eddcbe454d560939dfa8a9960ad0727..453b42b75c75afa27f7985eab8929b6f7e6fef36 100644 (file)
--- a/README
+++ b/README
@@ -6,10 +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).
 
-sigrok-meter is a special-purpose GUI for libsigrok (written in Python3, using
-PyGObject and GTK+3) which supports certain classes of test & measurement
-devices that usually provide slowly-updating measurement values, such as
-multimeters or dataloggers.
+sigrok-meter is a special-purpose GUI for libsigrok (written in Python + Qt)
+which supports certain classes of test & measurement devices that usually
+provide slowly-updating measurement values, such as multimeters or dataloggers.
 
 It does specifically NOT support logic analyzers, oscilloscopes, and
 mixed-signal oscilloscopes (MSOs).
@@ -27,10 +26,11 @@ Requirements
 ------------
 
  - git
- - Python >= 3.0
- - PyGObject
- - GTK+ >= 3.0
- - libsigrok >= 0.2.0 (including the Python bindings)
+ - Python (2 or 3)
+ - PyQt4 or PySide
+   (both need at least the QtCore and QtGui components)
+ - PyQtGraph
+ - libsigrok >= 0.4.0 (including the Python bindings)
 
 
 Building and installing
@@ -40,6 +40,7 @@ In order to get the sigrok-meter source code and build it, run:
 
  $ git clone git://sigrok.org/sigrok-meter
  $ cd sigrok-meter
+ $ make
  $ ./sigrok-meter
 
 For installing sigrok-meter:
@@ -59,24 +60,25 @@ sigrok-meter is licensed under the terms of the GNU General Public License
 
 While some individual source code files are licensed under the GPLv2+, and
 some files are licensed under the GPLv3+, this doesn't change the fact that
-the program as a whole is licensed under the terms of the GPLv3+.
+the program as a whole is licensed under the terms of the GPLv3+ (e.g. also
+due to the fact that it links against GPLv3+ libraries).
 
 Please see the individual source files for the full list of copyright holders.
 
+The sigrok logo is licensed under the CC-BY-SA 3.0 license, the icons from the
+Adwaita icon set are dual licenced under CC-BY-SA 3.0 and LGPLv3.
 
-Mailing lists
--------------
 
-There are two mailing lists for sigrok/sigrok-meter:
+Mailing list
+------------
 
  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 
 
 IRC
 ---
 
-You can find the sigrok developers in the #sigrok IRC channel on Freenode.
+You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
 
 
 Website