adf435x: Add an initial test-case.
[sigrok-test.git] / README
1 -------------------------------------------------------------------------------
2 README
3 -------------------------------------------------------------------------------
4
5 The sigrok project aims at creating a portable, cross-platform,
6 Free/Libre/Open-Source signal analysis software suite that supports various
7 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
8
9 sigrok-test is a collection of various tools and files for testing sigrok.
10
11
12 Status
13 ------
14
15 Work in progress.
16
17 Distro packagers should NOT package this!
18
19
20 Requirements
21 ------------
22
23  - git
24  - gcc
25  - make
26  - autoconf >= 2.63
27  - automake >= 1.11
28  - pkg-config >= 0.22
29  - libglib >= 2.24.0
30  - Python >= 3.2
31  - libsigrok >= 0.3.0
32  - libsigrokdecode >= 0.4.0
33  - python3-coverage
34
35
36 Building and usage
37 ------------------
38
39 Assumption: libsigrok and libsigrokdecode are installed in $HOME/sr.
40 If they are in a standard location instead, you don't need the
41 PKG_CONFIG_PATH and LD_LIBRARY_PATH below.
42
43 In order to get the sigrok-test source code and build it, run:
44
45  $ git clone git://sigrok.org/sigrok-test
46  $ cd sigrok-test
47  $ ./autogen.sh
48  $ PKG_CONFIG_PATH=$HOME/sr/lib/pkgconfig ./configure \
49         --with-decodersdir=/path/to/decoders
50  $ make
51
52 This will test the decoders located at /path/to/decoders:
53
54  $ LD_LIBRARY_PATH=$HOME/sr/lib ./decoder/pdtest -r -v -a
55
56
57 Copyright and license
58 ---------------------
59
60 sigrok-test contains various tools that are licensed under different terms.
61
62 Some are licensed under the terms of the GNU GPL version 2 (or later),
63 others under the terms of the GNU GPL version 3 (or later).
64
65 Please see the individual source files for the full list of copyright holders
66 and the license that applies to the respective tool.
67
68
69 Mailing list
70 ------------
71
72  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
73
74
75 IRC
76 ---
77
78 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
79
80
81 Website
82 -------
83
84  http://sigrok.org
85