commit ac22daf2c8a7963b77efbc675bf76141c2f7123b
parent 91a96bc2989ab7539ca75caff9440446f71075a7
Author: Dan Callaghan <djc@djc.id.au>
Date: Mon, 20 Sep 2010 14:22:29 +1000
list dependencies in README
Diffstat:
1 file changed, 29 insertions(+), 7 deletions(-)
diff --git a/README.markdown b/README.markdown
@@ -1,15 +1,37 @@
xmpedit
=======
-xmpedit is a graphical editor for metadata embedded in images using the
+xmpedit is a GTK+ editor for metadata embedded in images using the
[XMP](http://www.adobe.com/devnet/xmp.html) format. It is written in
-[Vala](http://live.gnome.org/Vala), using [GTK+](http://www.gtk.org/) for its
-GUI and [exiv2](http://www.exiv2.org/) for image manipulation.
+[Vala](http://live.gnome.org/Vala) and released under the
+[GPLv2](http://www.gnu.org/licenses/gpl-2.0.html).
-xmpedit is released under the [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html).
+Building xmpedit
+----------------
-Installing
-----------
+xmpedit depends on the following packages:
-Try running ./build and see what happens?
+* [GTK+](http://www.gtk.org/) (and its various dependencies, particularly GLib)
+* [Libgee](http://live.gnome.org/Libgee)
+* [Libxml2](http://xmlsoft.org/)
+* [libsoup](http://live.gnome.org/LibSoup), although this dependency should really go away
+* [Exiv2](http://www.exiv2.org/)
+
+The following additional dependencies are required to build xmpedit:
+
+* [Vala](http://live.gnome.org/Vala)
+* A C/C++ compiler (only tested with gcc)
+* Python
+
+Included in xmpedit are some automated GUI tests to verify its behaviour.
+Running these requires the following packages:
+
+* [dogtail](https://fedorahosted.org/dogtail/)
+* [Python X library](http://python-xlib.sourceforge.net/)
+
+xmpedit uses a custom build script written in Python. To build the
+program, invoke `./build` from the root of the source tree. An executable
+will be produced in `target/xmpedit` if all goes well.
+
+Invoke `./build -t` to run all tests.