From 90694a7f473f2912cd8042ce2cb1dc57563002c7 Mon Sep 17 00:00:00 2001 From: Cookie Engineer Date: Mon, 3 Oct 2016 00:25:35 +0200 Subject: Better README file with dependencies --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..4306cc7 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# ABOUT + +transmission-remote-gtk is a GTK client for remote management of +the Transmission BitTorrent client, using its HTTP RPC protocol. + + +# DEPENDENCIES + +The following packages are required dependencies: + +```bash +autoconf-archive appstream-glib intltool +``` + + +# BUILDING + +Optionally install `libgeoip` and its headers to see the country +origin of peers. + + +## Building a transmission-remote-gtk release from the command line: + +```bash +$ tar zxfv transmission-remote-gtk-1.2.tar.gz +$ cd transmission-remote-gtk-1.2 +$ ./configure +$ make +# make install +``` + +## Building from git clone: + +```bash +$ git clone https://github.com/transmission-remote-gtk/transmission-remote-gtk.git +$ ./autogen.sh +$ ./configure +$ make +# make install +``` + + +## LICENSE + +transmission-remote-gtk is released under GNU GPLv2. +See the [COPYING](./COPYING) file for details. + -- cgit v1.2.3