[sigrok-cli.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-cli is a command-line tool written in C, which uses both libsigrok
and libsigrokdecode to provide the basic sigrok functionality from the
command-line. Among other things, it's useful for scripting purposes.


Status
------

sigrok-cli is in a usable state and has had official tarball releases.


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

 - git
 - gcc
 - make
 - autoconf >= 2.63
 - automake >= 1.11
 - libtool
 - pkg-config >= 0.22
 - libglib >= 2.28.0
 - libsigrok >= 0.2.0
 - libsigrokdecode >= 0.1.0


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

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

 $ git clone git://sigrok.org/sigrok-cli
 $ cd sigrok-cli
 $ ./autogen.sh
 $ ./configure
 $ make

For installing sigrok-cli:

 $ make install

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

 http://sigrok.org/wiki/Building


Mailing lists
-------------

There are two mailing lists for sigrok/sigrok-cli:

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


IRC
---

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


Website
-------

 http://sigrok.org/wiki/Sigrok-cli
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-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
	17	sigrok-cli is in a usable state and has had official tarball releases.
	18
	19
	20	Requirements
	21	------------
	22
	23	- git
	24	- gcc
	25	- make
	26	- autoconf >= 2.63
	27	- automake >= 1.11
	28	- libtool
	29	- pkg-config >= 0.22
	30	- libglib >= 2.28.0
	31	- libsigrok >= 0.2.0
	32	- libsigrokdecode >= 0.1.0
	33
	34
	35	Building and installing
	36	-----------------------
	37
	38	In order to get the sigrok-cli source code and build it, run:
	39
	40	$ git clone git://sigrok.org/sigrok-cli
	41	$ cd sigrok-cli
	42	$ ./autogen.sh
	43	$ ./configure
	44	$ make
	45
	46	For installing sigrok-cli:
	47
	48	$ make install
	49
	50	See INSTALL or the following wiki page for more (OS-specific) instructions:
	51
	52	http://sigrok.org/wiki/Building
	53
	54
	55	Mailing lists
	56	-------------
	57
	58	There are two mailing lists for sigrok/sigrok-cli:
	59
	60	https://lists.sourceforge.net/lists/listinfo/sigrok-devel
	61	https://lists.sourceforge.net/lists/listinfo/sigrok-commits
	62
	63
	64	IRC
	65	---
	66
	67	You can find the sigrok developers in the #sigrok IRC channel on Freenode.
	68
	69
	70	Website
	71	-------
	72
	73	http://sigrok.org/wiki/Sigrok-cli
	74