Update .gitignore file.

[sigrok-gtk.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-gtk is a GTK+-based GUI for sigrok.


Status
------

sigrok-gtk is currently work in progress. Some basic functionality
is there, but it should still be considered alpha/beta stage software.

There have been no official tarball releases, yet.

Distro packagers should NOT package this, yet.


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

 - git
 - gcc
 - make
 - autoconf >= 2.63
 - automake >= 1.11
 - libtool
 - pkg-config >= 0.22
 - libglib >= 2.28.0
 - GTK+ >= 2.22.0
 - libsigrok >= 0.2.0


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

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

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

For installing sigrok-gtk:

 $ make install

Please see the following wiki pages for more detailed instructions:

 http://sigrok.org/wiki/Linux
 http://sigrok.org/wiki/Mac_OS_X
 http://sigrok.org/wiki/Windows
 http://sigrok.org/wiki/FreeBSD


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

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

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