[sigrok-util.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-util is a collection of various sigrok-related utilities.


Status
------

sigrok-util is in development and has not yet had official tarball releases.

Distro packagers should NOT package this, yet.


Requirements
------------

 - git
 - Python >= 3.0


Building and installing
-----------------------

In order to get the sigrok-util source code and build it, run:

 $ git clone git://sigrok.org/sigrok-util
 $ cd sigrok-util
 $ make

For installing sigrok-util:

 $ make install

See the following wiki page for more (OS-specific) instructions:

 http://sigrok.org/wiki/Building


Copyright and license
---------------------

sigrok-util contains various tools that are licensed under different terms.

Some are licensed under the terms of the GNU GPL version 2 (or later),
others under the terms of the GNU GPL version 3 (or later).

Please see the individual source files for the full list of copyright holders
and the license that applies to the respective tool.


Mailing list
------------

 https://lists.sourceforge.net/lists/listinfo/sigrok-devel


IRC
---

You can find the sigrok developers in the #sigrok IRC channel on Freenode.


Website
-------

 http://sigrok.org/wiki/Sigrok-util
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-util is a collection of various sigrok-related utilities.
	10
	11
	12	Status
	13	------
	14
	15	sigrok-util is in development and has not yet had official tarball releases.
	16
	17	Distro packagers should NOT package this, yet.
	18
	19
	20	Requirements
	21	------------
	22
	23	- git
	24	- Python >= 3.0
	25
	26
	27	Building and installing
	28	-----------------------
	29
	30	In order to get the sigrok-util source code and build it, run:
	31
	32	$ git clone git://sigrok.org/sigrok-util
	33	$ cd sigrok-util
	34	$ make
	35
	36	For installing sigrok-util:
	37
	38	$ make install
	39
	40	See the following wiki page for more (OS-specific) instructions:
	41
	42	http://sigrok.org/wiki/Building
	43
	44
	45	Copyright and license
	46	---------------------
	47
	48	sigrok-util contains various tools that are licensed under different terms.
	49
	50	Some are licensed under the terms of the GNU GPL version 2 (or later),
	51	others under the terms of the GNU GPL version 3 (or later).
	52
	53	Please see the individual source files for the full list of copyright holders
	54	and the license that applies to the respective tool.
	55
	56
	57	Mailing list
	58	------------
	59
	60	https://lists.sourceforge.net/lists/listinfo/sigrok-devel
	61
	62
	63	IRC
	64	---
	65
	66	You can find the sigrok developers in the #sigrok IRC channel on Freenode.
	67
	68
	69	Website
	70	-------
	71
	72	http://sigrok.org/wiki/Sigrok-util
	73