X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=README;h=3032095f7118271c82fe7681c43a1a3cc07e0c47;hp=00f115567b066970b8f939a555aedb86ead1be0a;hb=2da4987098b2370d5d23f61eded00d83780bb18c;hpb=6deff8e771bee3a3a24ee1e7b893c815c381252b diff --git a/README b/README index 00f1155..3032095 100644 --- 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-cli is a command-line tool written in C, which uses both libsigrok and libsigrokdecode to provide the basic sigrok functionality from the @@ -14,7 +14,7 @@ command-line. Among other things, it's useful for scripting purposes. Status ------ -The sigrok-cli project, while still in development, is pretty stable/usable. +sigrok-cli is in a usable state and has had official tarball releases. Requirements @@ -27,7 +27,7 @@ Requirements - automake >= 1.11 - libtool - pkg-config >= 0.22 - - libglib >= 2.22.0 + - libglib >= 2.28.0 - libsigrok >= 0.2.0 - libsigrokdecode >= 0.1.0 @@ -37,8 +37,8 @@ Building and installing In order to get the sigrok-cli source code and build it, run: - $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok - $ cd sigrok/sigrok-cli + $ git clone git://sigrok.org/sigrok-cli + $ cd sigrok-cli $ ./autogen.sh $ ./configure $ make @@ -47,12 +47,9 @@ For installing sigrok-cli: $ 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/Linux - http://sigrok.org/wiki/Mac_OS_X - http://sigrok.org/wiki/Windows - http://sigrok.org/wiki/FreeBSD + http://sigrok.org/wiki/Building Mailing lists @@ -73,5 +70,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode. Website ------- -http://sigrok.org + http://sigrok.org/wiki/Sigrok-cli