summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 47 insertions, 0 deletions
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.
+