]> sigrok.org Git - sigrok-meter.git/blame - README
Add initial sigrok-meter program.
[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
9sigrok-meter is special-purpose GUI for libsigrok (written in Python3, using
10PyGObject and GTK+3) which supports certain classes of test & measurement
11devices that usually provide slowly-updating measurement values, such as
12multimeters or dataloggers.
13
14It does specifically NOT support logic analyzers, oscilloscopes, and
15mixed-signal oscilloscopes (MSOs).
16
17
18Status
19------
20
21There have been no official tarball releases, yet.
22
23Distro packagers should NOT package this, yet.
24
25
26Requirements
27------------
28
29 - git
30 - Python >= 3.0
31 - PyGObject
32 - GTK+ >= 3.0
33 - libsigrok >= 0.2.0
34
35
36Building and installing
37-----------------------
38
39In order to get the sigrok-meter source code and build it, run:
40
41 $ git clone git://sigrok.org/sigrok-meter
42 $ cd sigrok-meter
43 $ ./sigrok-meter
44
45For installing sigrok-meter:
46
47 TODO.
48
49See INSTALL or the following wiki page for more (OS-specific) instructions:
50
51 http://sigrok.org/wiki/Building
52
53
54Copyright and license
55---------------------
56
57sigrok-meter is licensed under the terms of the GNU General Public License
58(GPL), version 3 or later.
59
60While some individual source code files are licensed under the GPLv2+, and
61some files are licensed under the GPLv3+, this doesn't change the fact that
62the program as a whole is licensed under the terms of the GPLv3+.
63
64Please see the individual source files for the full list of copyright holders.
65
66
67Mailing lists
68-------------
69
70There are two mailing lists for sigrok/sigrok-meter:
71
72 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
73 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
74
75
76IRC
77---
78
79You can find the sigrok developers in the #sigrok IRC channel on Freenode.
80
81
82Website
83-------
84
85 http://sigrok.org/wiki/Sigrok-meter
86