]> sigrok.org Git - libsigrok.git/blobdiff - README
updated URLs and description
[libsigrok.git] / README
diff --git a/README b/README
index b56414689ef2db1c61c758613a168af778fe5f26..eb8fb11689e6f6e0e85bf01a63586bd47da7a77e 100644 (file)
--- a/README
+++ b/README
@@ -3,12 +3,12 @@ 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.
 
 libsigrok is a shared library written in C which provides the basic API
-for talking to logic analyzer hardware and reading/writing the acquired data
-into various input/output file formats.
+for talking to hardware and reading/writing the acquired data into various
+input/output file formats.
 
 
 Requirements
@@ -21,11 +21,11 @@ Requirements
  - automake >= 1.11
  - libtool
  - pkg-config >= 0.22
- - libglib >= 2.22.0
- - libusb >= 1.0.5 (for most logic analyzer hardware)
+ - libglib >= 2.28.0
+ - libusb >= 1.0.5 (for most hardware)
  - libzip >= 0.8
- - libftdi >= 0.16 (for some logic analyzer hardware)
- - libudev >= 151 (for some logic analyzer hardware)
+ - libftdi >= 0.16 (for some hardware)
+ - libudev >= 151 (for some hardware)
 
 
 Building and installing
@@ -33,8 +33,8 @@ Building and installing
 
 In order to get the libsigrok source code and build it, run:
 
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
- $ cd sigrok/libsigrok
+ $ git clone git://sigrok.org/libsigrok
+ $ cd libsigrok
  $ ./autogen.sh
  $ ./configure
  $ make
@@ -51,6 +51,23 @@ Please see the following wiki pages for more detailed instructions:
  http://sigrok.org/wiki/FreeBSD
 
 
+Firmware
+--------
+
+Some devices supported by libsigrok need a firmware to be uploaded before the
+device can be used. 
+
+The default location where libsigrok expects the firmware files is:
+
+  $prefix/share/sigrok-firmware
+
+($prefix is usually /usr/local or /usr, depending on your ./configure options)
+
+For further information see:
+
+  http://sigrok.org/wiki/Firmware
+
+
 Mailing lists
 -------------