From: Uwe Hermann <uwe@hermann-uwe.de>
Date: Wed, 10 Oct 2012 21:43:00 +0000 (+0200)
Subject: Add README file.
X-Git-Url: http://git.code-monkey.de/?p=pulseview.git;a=commitdiff_plain;h=7a68af04fad429d32794c21149ed0bc38d0a934c

Add README file.
---

diff --git a/README b/README
new file mode 100644
index 0000000..dee7cdc
--- /dev/null
+++ b/README
@@ -0,0 +1,80 @@
+-------------------------------------------------------------------------------
+README
+-------------------------------------------------------------------------------
+
+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.
+
+
+Status
+------
+
+PulseView is currently work in progress. Some basic functionality
+is there, but it should still be considered alpha/beta stage software.
+
+There have been no official tarball releases, yet.
+
+Distro packagers should NOT package this, yet.
+
+
+Requirements
+------------
+
+ - git
+ - g++
+ - make
+ - libtool
+ - pkg-config >= 0.22
+ - cmake >= 2.6
+ - libglib >= 2.28.0
+ - Qt >= 4.5
+ - libboost >= 1.46
+ - libsigrok >= 0.2.0
+ - libsigrokdecode >= 0.1.0
+
+
+Building and installing
+-----------------------
+
+In order to get the PulseView source code and build it, run:
+
+ $ git clone git://sigrok.org/pulseview
+ $ cd pulseview
+ $ cmake .
+ $ make
+
+For installing PulseView:
+
+ $ 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
+
+
+Mailing lists
+-------------
+
+There are two mailing lists for sigrok/PulseView:
+
+ https://lists.sourceforge.net/lists/listinfo/sigrok-devel
+ https://lists.sourceforge.net/lists/listinfo/sigrok-commits
+
+
+IRC
+---
+
+You can find the sigrok developers in the #sigrok IRC channel on Freenode.
+
+
+Website
+-------
+
+ http://sigrok.org/wiki/PulseView
+