]> sigrok.org Git - sigrok-firmware.git/blame - README
doc: update IRC reference to Libera.Chat
[sigrok-firmware.git] / README
CommitLineData
ef1242e6
UH
1-------------------------------------------------------------------------------
2README
3-------------------------------------------------------------------------------
4
c1c8be39
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).
8
9sigrok-firmware is a collection of firmware files required for some of the
10devices libsigrok supports (logic analyzers, oscilloscopes, or others).
ef1242e6
UH
11
12We only carry firmware files for which we have an explicit permission/license
13that allows at _least_ redistribution of the firmware.
14
656a5bca 15
1e5a3976
GS
16Copyright and license
17---------------------
18
19The 'sigrok-firmware' project/repo/tarball has no license per se, since
20it's just a collection of firmware files from various sources.
21
22Copyright and license info for these firmware files is available here:
23
24 * asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.
25 * sysclk-lwla/*.rbf: See sysclk-lwla/LICENSE.LWLA.
26
27
c1c8be39
UH
28Status
29------
30
31sigrok-firmware is in a usable state and has had official tarball releases.
32
33
34Building and installing
35-----------------------
eb1a166a 36
c1c8be39
UH
37In order to get the sigrok-firmware source code and build it, run:
38
39 $ git clone git://sigrok.org/sigrok-firmware
40 $ cd sigrok-firmware
b6efd706
UH
41 $ ./autogen.sh
42 $ ./configure
c1c8be39
UH
43 $ make
44
45For installing sigrok-firmware:
eb1a166a
UH
46
47 $ make install
48
c1c8be39 49This will install the files into /usr/local/share/sigrok-firmware per default.
eb1a166a
UH
50
51You can override the install directory like this:
52
b6efd706 53 $ ./configure --prefix=/usr
eb1a166a 54
7bf9394c 55See INSTALL or the following wiki page for more (OS-specific) instructions:
c1c8be39 56
7bf9394c 57 http://sigrok.org/wiki/Building
c1c8be39 58
eb1a166a 59
2632d74e
UH
60Mailing list
61------------
c1c8be39
UH
62
63 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
c1c8be39
UH
64
65
66IRC
67---
68
11eed913 69You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
c1c8be39
UH
70
71
656a5bca
UH
72Website
73-------
74
c1c8be39 75 http://sigrok.org/wiki/Firmware
656a5bca 76