]> sigrok.org Git - sigrok-util.git/blame - README
Rename bundle.sh to sigrok-native-appimage for consistency.
[sigrok-util.git] / README
CommitLineData
6ee5004e
UH
1-------------------------------------------------------------------------------
2README
3-------------------------------------------------------------------------------
4
aceec517
UH
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).
6ee5004e 8
aceec517 9sigrok-util is a collection of various sigrok-related utilities.
6ee5004e 10
6ee5004e 11
aceec517
UH
12Status
13------
14
15sigrok-util is in development and has not yet had official tarball releases.
16
17Distro packagers should NOT package this, yet.
18
19
20Requirements
21------------
22
23 - git
24 - Python >= 3.0
25
26
27Building and installing
28-----------------------
29
30In order to get the sigrok-util source code and build it, run:
31
32 $ git clone git://sigrok.org/sigrok-util
33 $ cd sigrok-util
34 $ make
35
36For installing sigrok-util:
37
38 $ make install
39
daa48c31 40See the following wiki page for more (OS-specific) instructions:
aceec517 41
daa48c31 42 http://sigrok.org/wiki/Building
aceec517
UH
43
44
90ae5373
UH
45Copyright and license
46---------------------
47
48sigrok-util contains various tools that are licensed under different terms.
49
50Some are licensed under the terms of the GNU GPL version 2 (or later),
51others under the terms of the GNU GPL version 3 (or later).
52
53Please see the individual source files for the full list of copyright holders
54and the license that applies to the respective tool.
55
56
c4dc8c77
UH
57Mailing list
58------------
aceec517
UH
59
60 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
aceec517
UH
61
62
63IRC
64---
65
66You can find the sigrok developers in the #sigrok IRC channel on Freenode.
67
68
69Website
70-------
71
72 http://sigrok.org/wiki/Sigrok-util
6ee5004e 73