macosx: Refine pulseview executable invocation in wrapper script.

[sigrok-util.git] / README

diff --git a/README b/README
index 070a3ecb53df7501c445a693f451d97ec1186aa9..8c9207d213f7e6e2691ea4a9495142e314ef30f9 100644 (file)
--- a/README
+++ b/README
@@ -2,11 +2,72 @@
 README
 -------------------------------------------------------------------------------
 
-This is a collection of various sigrok-related utilities.
+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.
 
-Further information
--------------------
 
-http://sigrok.org
+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