projects / sigrok-cli.git / blame
| Commit | Line | Data |
|---|---|---|
| 34c6b368 UH |
1 | ------------------------------------------------------------------------------- |
| 2 | README | |
| 3 | ------------------------------------------------------------------------------- | |
| 4 | ||
| 5 | The sigrok project aims at creating a portable, cross-platform, | |
| 31dde8ac | 6 | Free/Libre/Open-Source signal analysis software suite that supports various |
| cdcf09f6 | 7 | device types (such as logic analyzers, oscilloscopes, multimeters, and more). |
| 34c6b368 UH |
8 | |
| 9 | sigrok-cli is a command-line tool written in C, which uses both libsigrok | |
| 10 | and libsigrokdecode to provide the basic sigrok functionality from the | |
| 11 | command-line. Among other things, it's useful for scripting purposes. | |
| 12 | ||
| 13 | ||
| 14 | Status | |
| 15 | ------ | |
| 16 | ||
| cdcf09f6 | 17 | sigrok-cli is in a usable state and has had official tarball releases. |
| 34c6b368 UH |
18 | |
| 19 | ||
| 20 | Requirements | |
| 21 | ------------ | |
| 22 | ||
| 23 | - git | |
| 2658103e UH |
24 | - gcc |
| 25 | - make | |
| 26 | - autoconf >= 2.63 | |
| 27 | - automake >= 1.11 | |
| 28 | - libtool | |
| 29 | - pkg-config >= 0.22 | |
| 366237a3 | 30 | - libglib >= 2.28.0 |
| c5e1e956 UH |
31 | - libsigrok >= 0.3.0 |
| 32 | - libsigrokdecode >= 0.3.0 | |
| 34c6b368 UH |
33 | |
| 34 | ||
| 35 | Building and installing | |
| 36 | ----------------------- | |
| 37 | ||
| 38 | In order to get the sigrok-cli source code and build it, run: | |
| 39 | ||
| 31dde8ac BV |
40 | $ git clone git://sigrok.org/sigrok-cli |
| 41 | $ cd sigrok-cli | |
| 34c6b368 UH |
42 | $ ./autogen.sh |
| 43 | $ ./configure | |
| 44 | $ make | |
| 45 | ||
| 46 | For installing sigrok-cli: | |
| 47 | ||
| 48 | $ make install | |
| 49 | ||
| 2da49870 | 50 | See INSTALL or the following wiki page for more (OS-specific) instructions: |
| 34c6b368 | 51 | |
| 2da49870 | 52 | http://sigrok.org/wiki/Building |
| 34c6b368 UH |
53 | |
| 54 | ||
| a8a380bd UH |
55 | Copyright and license |
| 56 | --------------------- | |
| 57 | ||
| 58 | sigrok-cli is licensed under the terms of the GNU General Public License | |
| 59 | (GPL), version 3 or later. | |
| 60 | ||
| 61 | While some individual source code files are licensed under the GPLv2+, and | |
| 62 | some files are licensed under the GPLv3+, this doesn't change the fact that | |
| 63 | the program as a whole is licensed under the terms of the GPLv3+. | |
| 64 | ||
| 65 | Please see the individual source files for the full list of copyright holders. | |
| 66 | ||
| 67 | ||
| 34c6b368 UH |
68 | Mailing lists |
| 69 | ------------- | |
| 70 | ||
| 71 | There are two mailing lists for sigrok/sigrok-cli: | |
| 72 | ||
| 73 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
| 74 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
| 75 | ||
| 76 | ||
| 77 | IRC | |
| 78 | --- | |
| 79 | ||
| 80 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
| 81 | ||
| 82 | ||
| 83 | Website | |
| 84 | ------- | |
| 85 | ||
| cdcf09f6 | 86 | http://sigrok.org/wiki/Sigrok-cli |
| 34c6b368 | 87 |