[Valgrind-valkyrie-dev] valkyrie: r518 - trunk

[<sv...@va...>]

Author: cerion
Date: 2010-09-16 22:21:43 +0100 (Thu, 16 Sep 2010)
New Revision: 518

Log:
update and add README

Added:
   trunk/README


Added: trunk/README
===================================================================
--- trunk/README	                        (rev 0)
+++ trunk/README	2010-09-16 21:21:43 UTC (rev 518)
@@ -0,0 +1,54 @@
+
+Release Notes for Valkyrie
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Valkyrie version 2.0.0.SVN supports Valgrind 3.6.x.
+Valkyrie supports the Valgrind tools Memcheck and Helgrind.
+
+Valkyrie is licensed under the GNU General Public License, version 2. 
+Read the file COPYING in the source distribution for details.
+
+For instructions on how to build/install, see the INSTALL file.
+
+
+Support for other versions of Valgrind
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Valkyrie is generally _not_ backwards compatible with other versions
+of Valgrind.  In particular, a particular Valkyrie release is tuned
+to a particular Valgrind XML interface definition.
+
+
+How to get Valkyrie
+~~~~~~~~~~~~~~~~~~~
+To check out Valkyrie via anonymous, read-only svn access:
+  svn co svn://svn.valgrind.org/valkyrie/trunk valkyrie
+
+
+Requirements
+~~~~~~~~~~~~
+Qt (>= not_sure, perhaps 4.6) <http://www.trolltech.com>
+Valgrind (>=v3.6.0) <http://www.valgrind.org>
+
+
+Executive Summary
+~~~~~~~~~~~~~~~~~
+Valkyrie is a GPL'd graphical front-end to the Valgrind suite
+of tools for debugging and profiling programs.
+
+Valkyrie uses the Qt widget library, and (should) run on any platform
+that both Qt and Valgrind run on.
+
+To get the most out of Valkyrie, you must read the Valgrind
+documentation: <http://www.valgrind.org/docs/>
+
+To get started, simply invoke valkyrie thusly:
+  valkyrie ./myprog
+
+This will transparently call Valgrind and display it's output.
+For more help on Valkyrie, use the built-in Help->Handbook.
+
+
+---
+The Valkyrie Developers
+Please report any problems encountered with valkyrie to
+<in...@op...>
+