diff options
| author |  Alan F <ajf8@users.noreply.github.com> | 2016-10-03 00:06:52 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2016-10-03 00:06:52 +0100 |
| commit | 1a749d823e8a6bf4cf985fce4f10279d550320a2 (patch) | |
| tree | ec25ac34a35b41060ecdfc595766ae9d1edd2a4e | |
| parent | 568016a5110f7987d6783afb51895f4c503e9292 (diff) | |
| parent | 90694a7f473f2912cd8042ce2cb1dc57563002c7 (diff) | |
Merge pull request #34 from cookiengineer/readme-fixes
Minor README fixes
| -rw-r--r-- | README | 25 | ||||
| -rw-r--r-- | README.md | 47 |
2 files changed, 47 insertions, 25 deletions
@@ -1,25 +0,0 @@ -ABOUT - - transmission-remote-gtk is a GTK client for remote management of - the Transmission BitTorrent client, using its HTTP RPC protocol. - -BUILDING - - * To optionally see which country peers are located in, - install libgeoip and its headers when building. - - Building a transmission-remote-gtk release from the command line: - - $ tar zxfv transmission-remote-gtk-1.2.tar.gz - $ cd transmission-remote-gtk-1.2 - $ ./configure - $ make - # make install - - Building from git clone: - - $ git clone https://github.com/transmission-remote-gtk/transmission-remote-gtk.git - $ ./autogen.sh - $ ./configure - $ make - # make install 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. + |