From dd5cc0bde01b22c30357d0d96f64bcea5d94f555 Mon Sep 17 00:00:00 2001 From: "L. Bradley LaBoon" Date: Fri, 29 Jun 2018 23:33:30 -0400 Subject: [PATCH] Converted README to markdown --- README => README.md | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) rename README => README.md (79%) diff --git a/README b/README.md similarity index 79% rename from README rename to README.md index 3f51398..78c4620 100644 --- a/README +++ b/README.md @@ -1,5 +1,6 @@ -About Overdrive -=============== +# Overdrive + +## About Overdrive Overdrive is an alternative web interface for the Transmission torrent program. There are a number of issues that I have with the web interface that comes with @@ -25,47 +26,40 @@ even published this version is for historical purposes. There is no ETA for the new version, so don't ask. -Requirements -============ +## Requirements Overdrive should work with the latest version of any browser. -Installation -============ +## Installation The files in this repository need to be installed in one of several locations in order for Transmission to use it (instead of the built-in interface). You can pick one of the following locations: -$HOME/.local/share/transmission/web (where $HOME is the home directory of the -user Transmission is running as) - -/usr/local/share/transmission/web - -/usr/share/transmission/web (this is the location of the default interface) +* `$HOME/.local/share/transmission/web` (where `$HOME` is the home directory of +the user Transmission is running as) +* `/usr/local/share/transmission/web` +* `/usr/share/transmission/web` (this is the location of the default interface) Transmission will search the directories in the order in which they are listed above. Thus, it will fallback to the default interface only if none of the other locations exist. -How to report bugs? -=================== +## How to report bugs? -Bugs should be reported to L. Bradley LaBoon . +Open an issue on the issue tracker. Since I am currently working on re-writing the interface (as mentioned above), I will probably not update the existing code. However, the fix will be included in the new version (if applicable). -Credits -======= +## Credits The icons used at the top of the interface are part of the "Button Icons" set -created by Hopstarter. They are available at the following URL: - +created by Hopstarter. They are available [here](http://www.iconarchive.com/show/button-icons-by-hopstarter.html). The "B" Logo is Copyright (C) L. Bradley LaBoon, and will eventually be replaced with a project-specific logo.