X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=README;h=588edc4cc6a32ceb34daf712977f5d7afca402a2;hp=a0552251abc38e29a6de084bc397e980974b32c8;hb=edf9f6bb11b13559afba60834be6e8d3578f03c0;hpb=bc9edd9d5f7871272f4bbe5fc72bcc04983487e5 diff --git a/README b/README index a0552251..588edc4c 100644 --- a/README +++ b/README @@ -6,78 +6,87 @@ 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 ------------- +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). - - git - - g++ - - make - - libtool - - pkg-config >= 0.22 - - cmake >= 2.6 - - libglib >= 2.28.0 - - Qt >= 4.5 - - libboost >= 1.42 (including the following libs): - - libboost-system - - libboost-thread - - libsigrok >= 0.2.0 - - libsigrokdecode >= 0.1.0 +Please see the individual source files for the full list of copyright holders. -Building and installing ------------------------ +Copyright notices +----------------- -In order to get the PulseView source code and build it, run: +A copyright notice indicating a range of years, must be interpreted as having +had copyrightable material added in each of those years. - $ git clone git://sigrok.org/pulseview - $ cd pulseview - $ cmake . - $ make +Example: -For installing PulseView: + Copyright (C) 2010-2013 Contributor Name - $ make install +is to be interpreted as -Please see the following wiki pages for more detailed instructions: + Copyright (C) 2010,2011,2012,2013 Contributor Name - http://sigrok.org/wiki/Linux - http://sigrok.org/wiki/Mac_OS_X - http://sigrok.org/wiki/Windows - http://sigrok.org/wiki/FreeBSD +Resource authors and licenses +----------------------------- -Creating a source distribution package --------------------------------------- +icons/application-exit.png, +icons/document-new.png, +icons/document-open.png, +icons/document-save-as.png, +icons/help-browser.png, +icons/media-playback-pause.png, +icons/media-playback-start.png, +icons/preferences-system.png, +icons/search.svg, +icons/window-new.png, +icons/zoom-fit-best.png, +icons/zoom-in.png, +icons/zoom-out.png: Tango Icon Library + http://tango.freedesktop.org/Tango_Desktop_Project + License: + Public Domain -In order to build a source package begin with an unconfigured source tree. +icons/information.svg: Bobarino + https://en.wikipedia.org/wiki/File:Information.svg + License: + GFDL 1.2 or later / CC-BY-SA 3.0 + https://en.wikipedia.org/wiki/File:Information.svg#Licensing - $ mkdir dist - $ cd dist - $ cmake .. - $ make package_source +QDarkStyleSheet: Colin Duquesnoy + https://github.com/ColinDuquesnoy/QDarkStyleSheet + License: + CC-BY 4.0 + https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/LICENSE.md +DarkStyle: Juergen Skrotzky + https://github.com/Jorgen-VikingGod/Qt-Frameless-Window-DarkStyle + License: + MIT license + https://github.com/Jorgen-VikingGod/Qt-Frameless-Window-DarkStyle#licence -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