]> sigrok.org Git - sigrok-util.git/blame - README
add new-driver tool
[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
40Please see the following wiki pages for more detailed instructions:
41
42 http://sigrok.org/wiki/Linux
43 http://sigrok.org/wiki/Mac_OS_X
44 http://sigrok.org/wiki/Windows
45 http://sigrok.org/wiki/FreeBSD
46
47
48Mailing lists
49-------------
50
51There are two mailing lists for sigrok/sigrok-util:
52
53 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
54 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
55
56
57IRC
58---
59
60You can find the sigrok developers in the #sigrok IRC channel on Freenode.
61
62
63Website
64-------
65
66 http://sigrok.org/wiki/Sigrok-util
6ee5004e 67