]> sigrok.org Git - sigrok-meter.git/blame - README
Make program run with PySide too.
[sigrok-meter.git] / README
CommitLineData
92e09fc0
UH
1-------------------------------------------------------------------------------
2README
3-------------------------------------------------------------------------------
4
5The sigrok project aims at creating a portable, cross-platform,
6Free/Libre/Open-Source signal analysis software suite that supports various
7device types (such as logic analyzers, oscilloscopes, multimeters, and more).
8
d00a3973
UH
9sigrok-meter is a special-purpose GUI for libsigrok (written in Python + Qt)
10which supports certain classes of test & measurement devices that usually
11provide slowly-updating measurement values, such as multimeters or dataloggers.
92e09fc0
UH
12
13It does specifically NOT support logic analyzers, oscilloscopes, and
14mixed-signal oscilloscopes (MSOs).
15
16
17Status
18------
19
20There have been no official tarball releases, yet.
21
22Distro packagers should NOT package this, yet.
23
24
25Requirements
26------------
27
28 - git
d00a3973
UH
29 - Python
30 - PyQt4
31 - libsigrok >= 0.3.0 (including the Python bindings)
92e09fc0
UH
32
33
34Building and installing
35-----------------------
36
37In order to get the sigrok-meter source code and build it, run:
38
39 $ git clone git://sigrok.org/sigrok-meter
40 $ cd sigrok-meter
41 $ ./sigrok-meter
42
43For installing sigrok-meter:
44
45 TODO.
46
47See INSTALL or the following wiki page for more (OS-specific) instructions:
48
49 http://sigrok.org/wiki/Building
50
51
52Copyright and license
53---------------------
54
55sigrok-meter is licensed under the terms of the GNU General Public License
56(GPL), version 3 or later.
57
58While some individual source code files are licensed under the GPLv2+, and
59some files are licensed under the GPLv3+, this doesn't change the fact that
24baa3c6
UH
60the program as a whole is licensed under the terms of the GPLv3+ (e.g. also
61due to the fact that it links against GPLv3+ libraries).
92e09fc0
UH
62
63Please see the individual source files for the full list of copyright holders.
64
65
d81a7a63
UH
66Mailing list
67------------
92e09fc0
UH
68
69 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
92e09fc0
UH
70
71
72IRC
73---
74
75You can find the sigrok developers in the #sigrok IRC channel on Freenode.
76
77
78Website
79-------
80
81 http://sigrok.org/wiki/Sigrok-meter
82