]> sigrok.org Git - sigrok-firmware.git/blame - README
README: Add status, update URL, add more info.
[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
c1c8be39
UH
16Status
17------
18
19sigrok-firmware is in a usable state and has had official tarball releases.
20
21
22Building and installing
23-----------------------
eb1a166a 24
c1c8be39
UH
25In order to get the sigrok-firmware source code and build it, run:
26
27 $ git clone git://sigrok.org/sigrok-firmware
28 $ cd sigrok-firmware
29 $ make
30
31For installing sigrok-firmware:
eb1a166a
UH
32
33 $ make install
34
c1c8be39 35This will install the files into /usr/local/share/sigrok-firmware per default.
eb1a166a
UH
36
37You can override the install directory like this:
38
39 $ make DESTDIR=/tmp/foo install
40
c1c8be39
UH
41Please see the following wiki pages for more detailed instructions:
42
43 http://sigrok.org/wiki/Linux
44 http://sigrok.org/wiki/Mac_OS_X
45 http://sigrok.org/wiki/Windows
46 http://sigrok.org/wiki/FreeBSD
47
eb1a166a
UH
48
49Licenses
50--------
51
52 * asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.
53
54
c1c8be39
UH
55Mailing lists
56-------------
57
58There are two mailing lists for sigrok/sigrok-firmware:
59
60 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
61 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
62
63
64IRC
65---
66
67You can find the sigrok developers in the #sigrok IRC channel on Freenode.
68
69
656a5bca
UH
70Website
71-------
72
c1c8be39 73 http://sigrok.org/wiki/Firmware
656a5bca 74