Trace: Removed coloured_bg state
[pulseview.git] / README
diff --git a/README b/README
index 6788213d5f624fc06ec84cffb99e685750064e20..613ecc5c2faba3be33fe45f831586aaa474eaeb2 100644 (file)
--- a/README
+++ b/README
@@ -6,75 +6,55 @@ 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).
 
-PulseView is a Qt-based GUI for sigrok.
+PulseView is a Qt-based LA/scope/MSO GUI for sigrok.
 
 
 Status
 ------
 
-PulseView is currently work in progress. Some basic functionality
-is there, but it should still be considered alpha/beta stage software.
+PulseView is in a usable state and has had official tarball releases.
 
-There have been no official tarball releases, yet.
 
-Distro packagers should NOT package this, yet.
+Copyright and license
+---------------------
 
+PulseView is licensed under the terms of the GNU General Public License
+(GPL), version 3 or later.
 
-Requirements
-------------
-
- - git
- - g++
- - make
- - libtool
- - pkg-config >= 0.22
- - cmake >= 2.6
- - libglib >= 2.28.0
- - Qt >= 4.5
- - libboost >= 1.45 (including the following libs):
-    - libboost-system
-    - libboost-thread
- - libsigrok >= 0.2.0
- - libsigrokdecode >= 0.1.0
+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+ (e.g. also
+due to the fact that it links against GPLv3+ libraries).
 
+Please see the individual source files for the full list of copyright holders.
 
-Building and installing
------------------------
 
-In order to get the PulseView source code and build it, run:
+Copyright notices
+-----------------
 
- $ git clone git://sigrok.org/pulseview
- $ cd pulseview
- $ cmake .
- $ make
+A copyright notice indicating a range of years, must be interpreted as having
+had copyrightable material added in each of those years.
 
-For installing PulseView:
+Example:
 
- $ make install
+ Copyright (C) 2010-2013 Contributor Name
 
-Please see the following wiki pages for more detailed instructions:
+is to be interpreted as
 
- http://sigrok.org/wiki/Linux
- http://sigrok.org/wiki/Mac_OS_X
- http://sigrok.org/wiki/Windows
- http://sigrok.org/wiki/FreeBSD
+ Copyright (C) 2010,2011,2012,2013 Contributor Name
 
-Creating a source distribution package
---------------------------------------
 
-In order to build a source package begin with an unconfigured source tree.
+Icons authors and licenses
+--------------------------
 
- $ mkdir dist/
- $ cmake ../
- $ make package_sources
+icons/information.svg: Bobarino
+  https://en.wikipedia.org/wiki/File:Information.svg
 
-Mailing lists
--------------
 
-There are two mailing lists for sigrok/PulseView:
+Mailing list
+------------
 
  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 
 
 IRC