[sigrok-dumps.git] / README

-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------

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).


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
------------------

See http://sigrok.org/wiki/Example_dumps for details.


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/wiki/Example_dumps
Commit	Line	Data
	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-dumps is a collection of logic analyzer example data, covering various
	10	protocols (e.g. I2C, SPI, UART, etc).
	11
	12
	13	Status
	14	------
	15
	16	sigrok-dumps is in a usable state and has had official tarball releases.
	17
	18
	19	Installing
	20	----------
	21
	22	Example captures need not get built or compiled, but can get installed.
	23
	24	$ git clone git://sigrok.org/sigrok-dumps
	25	$ cd sigrok-dumps
	26	$ make install
	27
	28	Optional PREFIX or DESTDIR specs are supported as well.
	29
	30	$ make PREFIX=/usr install
	31	$ make PREFIX=${HOME} install
	32
	33	$ make DESTDIR=$( pwd )/rootfs install
	34
	35
	36	Contributing dumps
	37	------------------
	38
	39	See http://sigrok.org/wiki/Example_dumps for details.
	40
	41
	42	Copyright and license
	43	---------------------
	44
	45	Unless noted otherwise, all dump files are hereby released into the
	46	public domain by their authors.
	47
	48
	49	Mailing list
	50	------------
	51
	52	https://lists.sourceforge.net/lists/listinfo/sigrok-devel
	53
	54
	55	IRC
	56	---
	57
	58	You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
	59
	60
	61	Website
	62	-------
	63
	64	http://sigrok.org/wiki/Example_dumps
	65