X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=README;h=535538289008f48b503606783d7ee90715fad894;hp=87d03115685944c6a026c27a285bdbfe917972c5;hb=dd671ce797d8eb49d7d883df3ae65145033607cf;hpb=34c6b368f40e5c570e2272fab9afa2bfde3ba207 diff --git a/README b/README index 87d0311..5355382 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,18 +14,22 @@ 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 ------------ - git - - gcc, g++, make, ... - - autoconf, automake, libtool, pkg-config - - libglib >= 2.22.0 - - libsigrok - - libsigrokdecode + - gcc + - make + - autoconf >= 2.63 + - automake >= 1.11 + - libtool + - pkg-config >= 0.22 + - libglib >= 2.28.0 + - libsigrok >= 0.2.0 + - libsigrokdecode >= 0.2.0 Building and installing @@ -33,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 @@ -43,12 +47,22 @@ 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 + + +Copyright and license +--------------------- + +sigrok-cli 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+. + +Please see the individual source files for the full list of copyright holders. Mailing lists @@ -69,5 +83,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode. Website ------- -http://sigrok.org + http://sigrok.org/wiki/Sigrok-cli