projects / libsigrok.git / blame
| Commit | Line | Data |
|---|---|---|
| 13177edb UH |
1 | ------------------------------------------------------------------------------- |
| 2 | README | |
| 3 | ------------------------------------------------------------------------------- | |
| 4 | ||
| 5 | The sigrok project aims at creating a portable, cross-platform, | |
| 6 | Free/Libre/Open-Source logic analyzer software that supports various | |
| 7 | logic analyzer hardware products. | |
| 8 | ||
| 9 | libsigrok is a shared library written in C which provides the basic API | |
| 10 | for talking to logic analyzer hardware and reading/writing the acquired data | |
| 11 | into various input/output file formats. | |
| 12 | ||
| 13 | ||
| 13177edb UH |
14 | Requirements |
| 15 | ------------ | |
| 16 | ||
| 17 | - git | |
| 1a081ca6 | 18 | - gcc (>= 4.0) |
| ef7228ba UH |
19 | - make |
| 20 | - autoconf >= 2.63 | |
| 21 | - automake >= 1.11 | |
| 22 | - libtool | |
| 23 | - pkg-config >= 0.22 | |
| 13177edb UH |
24 | - libglib >= 2.22.0 |
| 25 | - libusb >= 1.0.5 (for most logic analyzer hardware) | |
| 26 | - libzip >= 0.8 | |
| 13177edb UH |
27 | - libftdi >= 0.16 (for some logic analyzer hardware) |
| 28 | - libudev >= 151 (for some logic analyzer hardware) | |
| 29 | ||
| 30 | ||
| 31 | Building and installing | |
| 32 | ----------------------- | |
| 33 | ||
| 34 | In order to get the libsigrok source code and build it, run: | |
| 35 | ||
| 36 | $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok | |
| 37 | $ cd sigrok/libsigrok | |
| 38 | $ ./autogen.sh | |
| 39 | $ ./configure | |
| 40 | $ make | |
| 41 | ||
| 42 | For installing libsigrok: | |
| 43 | ||
| 44 | $ make install | |
| 45 | ||
| 46 | Please see the following wiki pages for more detailed instructions: | |
| 47 | ||
| 48 | http://sigrok.org/wiki/Linux | |
| 49 | http://sigrok.org/wiki/Mac_OS_X | |
| 50 | http://sigrok.org/wiki/Windows | |
| 51 | http://sigrok.org/wiki/FreeBSD | |
| 52 | ||
| 53 | ||
| f9a33a47 UH |
54 | Firmware |
| 55 | -------- | |
| 56 | ||
| 57 | Some devices supported by libsigrok need a firmware to be uploaded before the | |
| 58 | device can be used. | |
| 59 | ||
| 60 | The default location where libsigrok expects the firmware files is: | |
| 61 | ||
| 62 | $prefix/share/sigrok-firmware | |
| 63 | ||
| 64 | ($prefix is usually /usr/local or /usr, depending on your ./configure options) | |
| 65 | ||
| 66 | For further information see: | |
| 67 | ||
| 68 | http://sigrok.org/wiki/Firmware | |
| 69 | ||
| 70 | ||
| 13177edb UH |
71 | Mailing lists |
| 72 | ------------- | |
| 73 | ||
| 74 | There are two mailing lists for sigrok/libsigrok: | |
| 75 | ||
| 76 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
| 77 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
| 78 | ||
| 79 | ||
| 80 | IRC | |
| 81 | --- | |
| 82 | ||
| 83 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
| 84 | ||
| 85 | ||
| 86 | Website | |
| 87 | ------- | |
| 88 | ||
| 89 | http://sigrok.org | |
| 90 |