Code drop from DreamSourceLabs first source release.

[libsigrok.git] / README

diff --git a/README b/README
index 7439d0c2f241df6077dc86c84c39a051e8b9f030..437294c40b09b8fb34539f1e2af50a99c862fc29 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,9 @@
 -------------------------------------------------------------------------------
 README
 -------------------------------------------------------------------------------
+libsigrok4DSLogic is a shared library which provides the basic API
+for DSLogic hardware.
+libsigrok4DSLogic is based on libsigrok, a shared library from the sigrok project.
 
 The sigrok project aims at creating a portable, cross-platform,
 Free/Libre/Open-Source signal analysis software suite that supports various
@@ -34,51 +37,44 @@ Requirements
  - automake >= 1.11
  - libtool
  - pkg-config >= 0.22
- - libglib >= 2.28.0
- - libusb >= 1.0.5 (for most hardware)
+ - libglib >= 2.32.0
  - libzip >= 0.8
- - libftdi >= 0.16 (for some hardware)
- - libudev >= 151 (for some hardware)
+ - libusb-1.0 >= 1.0.9 (optional, used by most drivers)
+ - libftdi >= 0.16 (optional, used by some drivers)
+ - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
+ - check >= 0.9.4 (optional, only needed to run unit tests)
 
 
 Building and installing
 -----------------------
+Get the libsigrok4DSLogic source code from: www.dreamsourcelab.com/download.html
+In order to build it, run:
 
-In order to get the libsigrok source code and build it, run:
-
- $ git clone git://sigrok.org/libsigrok
  $ cd libsigrok
  $ ./autogen.sh
  $ ./configure
  $ make
 
-For installing libsigrok:
+For installing libsigrok4DSLogic:
 
  $ 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
-
-
-Firmware
---------
+See INSTALL or the following wiki page for more (OS-specific) instructions:
 
-Some devices supported by libsigrok need a firmware to be uploaded before the
-device can be used. 
+ http://sigrok.org/wiki/Building
 
-The default location where libsigrok expects the firmware files is:
 
-  $prefix/share/sigrok-firmware
+Copyright and license
+---------------------
 
-($prefix is usually /usr/local or /usr, depending on your ./configure options)
+libsigrok4DSLogic is licensed under the terms of the GNU General Public License
+(GPL), version 3 or later.
 
-For further information see:
+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 library as a whole is licensed under the terms of the GPLv3+.
 
-  http://sigrok.org/wiki/Firmware
+Please see the individual source files for the full list of copyright holders.
 
 
 Mailing lists
@@ -100,4 +96,5 @@ Website
 -------
 
  http://sigrok.org/wiki/Libsigrok
+ http://dreamsourcelab.com