]> sigrok.org Git - sigrok-gtk.git/blame - README
README: Add "Copyright and license" section.
[sigrok-gtk.git] / README
CommitLineData
982c5160
UH
1-------------------------------------------------------------------------------
2README
3-------------------------------------------------------------------------------
4
5The sigrok project aims at creating a portable, cross-platform,
0797c521
UH
6Free/Libre/Open-Source signal analysis software suite that supports various
7device types (such as logic analyzers, oscilloscopes, multimeters, and more).
982c5160
UH
8
9sigrok-gtk is a GTK+-based GUI for sigrok.
10
11
12Status
13------
14
0797c521 15sigrok-gtk is currently work in progress. Some basic functionality
982c5160
UH
16is there, but it should still be considered alpha/beta stage software.
17
0797c521
UH
18There have been no official tarball releases, yet.
19
20Distro packagers should NOT package this, yet.
21
982c5160
UH
22
23Requirements
24------------
25
26 - git
71eeb08b
UH
27 - gcc
28 - make
29 - autoconf >= 2.63
30 - automake >= 1.11
31 - libtool
32 - pkg-config >= 0.22
0e47d2b1 33 - libglib >= 2.28.0
982c5160 34 - GTK+ >= 2.22.0
49e82e87 35 - libsigrok >= 0.2.0
982c5160
UH
36
37
38Building and installing
39-----------------------
40
41In order to get the sigrok-gtk source code and build it, run:
42
0797c521
UH
43 $ git clone git://sigrok.org/sigrok-gtk
44 $ cd sigrok-gtk
982c5160
UH
45 $ ./autogen.sh
46 $ ./configure
47 $ make
48
49For installing sigrok-gtk:
50
51 $ make install
52
4ec03e86 53See INSTALL or the following wiki page for more (OS-specific) instructions:
982c5160 54
4ec03e86 55 http://sigrok.org/wiki/Building
982c5160
UH
56
57
1fe3e6cc
UH
58Copyright and license
59---------------------
60
61sigrok-gtk is licensed under the terms of the GNU General Public License
62(GPL), version 3 or later.
63
64While some individual source code files are licensed under the GPLv2+, and
65some files are licensed under the GPLv3+, this doesn't change the fact that
66the program as a whole is licensed under the terms of the GPLv3+.
67
68Please see the individual source files for the full list of copyright holders.
69
70
982c5160
UH
71Mailing lists
72-------------
73
74There are two mailing lists for sigrok/sigrok-gtk:
75
76 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
77 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
78
79
80IRC
81---
82
83You can find the sigrok developers in the #sigrok IRC channel on Freenode.
84
85
86Website
87-------
88
0797c521 89 http://sigrok.org/wiki/Sigrok-gtk
982c5160 90