X-Git-Url: http://sigrok.org/gitweb/?p=sigrok-dumps.git;a=blobdiff_plain;f=README;h=cc6a1259f15de7f8c87959a1bdda6d880e3ff4f3;hp=8f09c6bcc8063b39975efc94eb9dbc1ad6288722;hb=HEAD;hpb=18c8803d65ec961e96c62d933e08641fdcc6742b diff --git a/README b/README index 8f09c6b..724a738 100644 --- a/README +++ b/README @@ -2,15 +2,35 @@ README ------------------------------------------------------------------------------- -This is a collection of logic analyzer example data, covering various -protocols (e.g. I2C, SPI, USART, etc). +The sigrok project aims at creating a portable, cross-platform, +Free/Libre/Open-Source signal analysis software suite that supports various +device types (such as logic analyzers, oscilloscopes, multimeters, and more). +sigrok-dumps is a collection of logic analyzer example data, covering various +protocols (e.g. I2C, SPI, UART, etc). -License -------- -Unless noted otherwise, all dump files are hereby released into the -public domain by their authors. +Status +------ + +sigrok-dumps is in a usable state and has had official tarball releases. + + +Installing +---------- + +Example captures need not get built or compiled, but can get installed. + + $ git clone git://sigrok.org/sigrok-dumps + $ cd sigrok-dumps + $ make install + +Optional PREFIX or DESTDIR specs are supported as well. + + $ make PREFIX=/usr install + $ make PREFIX=${HOME} install + + $ make DESTDIR=$( pwd )/rootfs install Contributing dumps @@ -19,8 +39,27 @@ Contributing dumps See http://sigrok.org/wiki/Example_dumps for details. -Further information -------------------- +Copyright and license +--------------------- + +Unless noted otherwise, all dump files are hereby released into the +public domain by their authors. + + +Mailing list +------------ + + https://lists.sourceforge.net/lists/listinfo/sigrok-devel + + +IRC +--- + +You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat. + + +Website +------- -http://sigrok.org + http://sigrok.org/wiki/Example_dumps