README: Add "Copyright and license" section.

[sigrok-gtk.git] / README

diff --git a/README b/README
index 49499dffbca9d001e5061b9f2b1e09d3138d2835..18a3e5f9970c12ec556b8b0991251b6624474a88 100644 (file)
--- a/README
+++ b/README
@@ -3,8 +3,8 @@ README
 -------------------------------------------------------------------------------
 
 The sigrok project aims at creating a portable, cross-platform,
-Free/Libre/Open-Source logic analyzer software that supports various
-logic analyzer hardware products.
+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.
 
@@ -12,9 +12,13 @@ sigrok-gtk is a GTK+-based GUI for sigrok.
 Status
 ------
 
-The sigrok-gtk project is currently work in progress. Some basic functionality
+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
 ------------
@@ -26,7 +30,7 @@ Requirements
  - automake >= 1.11
  - libtool
  - pkg-config >= 0.22
- - libglib >= 2.22.0
+ - libglib >= 2.28.0
  - GTK+ >= 2.22.0
  - libsigrok >= 0.2.0
 
@@ -36,8 +40,8 @@ Building and installing
 
 In order to get the sigrok-gtk source code and build it, run:
 
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
- $ cd sigrok/sigrok-gtk
+ $ git clone git://sigrok.org/sigrok-gtk
+ $ cd sigrok-gtk
  $ ./autogen.sh
  $ ./configure
  $ make
@@ -46,12 +50,22 @@ For installing sigrok-gtk:
 
  $ make install
 
-Please see the following wiki pages for more detailed instructions:
+See INSTALL or the following wiki page for more (OS-specific) instructions:
+
+ http://sigrok.org/wiki/Building
+
+
+Copyright and license
+---------------------
+
+sigrok-gtk is licensed under the terms of the GNU General Public License
+(GPL), version 3 or later.
+
+While some individual source code files are licensed under the GPLv2+, and
+some files are licensed under the GPLv3+, this doesn't change the fact that
+the program as a whole is licensed under the terms of the GPLv3+.
 
- http://sigrok.org/wiki/Linux
- http://sigrok.org/wiki/Mac_OS_X
- http://sigrok.org/wiki/Windows
- http://sigrok.org/wiki/FreeBSD
+Please see the individual source files for the full list of copyright holders.
 
 
 Mailing lists
@@ -72,5 +86,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Sigrok-gtk