[sigrok-firmware.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-firmware is a collection of firmware files required for some of the
devices libsigrok supports (logic analyzers, oscilloscopes, or others).

We only carry firmware files for which we have an explicit permission/license
that allows at _least_ redistribution of the firmware.


Status
------

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


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

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

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

For installing sigrok-firmware:

  $ make install

This will install the files into /usr/local/share/sigrok-firmware per default.

You can override the install directory like this:

  $ ./configure --prefix=/usr

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

 http://sigrok.org/wiki/Building


Licenses
--------

 * asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.


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

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

 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/Firmware
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-firmware is a collection of firmware files required for some of the
	10	devices libsigrok supports (logic analyzers, oscilloscopes, or others).
	11
	12	We only carry firmware files for which we have an explicit permission/license
	13	that allows at _least_ redistribution of the firmware.
	14
	15
	16	Status
	17	------
	18
	19	sigrok-firmware is in a usable state and has had official tarball releases.
	20
	21
	22	Building and installing
	23	-----------------------
	24
	25	In order to get the sigrok-firmware source code and build it, run:
	26
	27	$ git clone git://sigrok.org/sigrok-firmware
	28	$ cd sigrok-firmware
	29	$ ./autogen.sh
	30	$ ./configure
	31	$ make
	32
	33	For installing sigrok-firmware:
	34
	35	$ make install
	36
	37	This will install the files into /usr/local/share/sigrok-firmware per default.
	38
	39	You can override the install directory like this:
	40
	41	$ ./configure --prefix=/usr
	42
	43	See INSTALL or the following wiki page for more (OS-specific) instructions:
	44
	45	http://sigrok.org/wiki/Building
	46
	47
	48	Licenses
	49	--------
	50
	51	* asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.
	52
	53
	54	Mailing lists
	55	-------------
	56
	57	There are two mailing lists for sigrok/sigrok-firmware:
	58
	59	https://lists.sourceforge.net/lists/listinfo/sigrok-devel
	60	https://lists.sourceforge.net/lists/listinfo/sigrok-commits
	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/Firmware
	73