diff --git a/README.md b/README.md index e9edbba..02b78cb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -

![](https://github.com/belltown/violetbug/blob/master/doc/icon.png) VioletBug — Roku Debugger Graphical Interface

+

![](https://raw.githubusercontent.com/belltown/violetbug/master/doc/icon.png) VioletBug — Roku Debugger Graphical Interface

VioletBug is a cross-platform desktop application providing a graphical interface to the Roku Debugger as an alternative to Telnet. It is similar to PurpleBug, https://belltown-roku.tk/PurpleBug, which is still supported; however, PurpleBug only runs on Windows PCs, and is closed-source. VioletBug, in contrast, is open-source running under [Electron](http://electron.atom.io/) and [Node.js](https://nodejs.org), written entirely in HTML, CSS and JavaScript. The source code can be found on [GitHub](https://github.com/belltown/violetbug). +Note that VioletBug is not intended as a general-purpose Telnet client, and as such only offers features deemed to be relevant to debugging a Roku device, e.g. Rokus can only be addressed by IP address, not by host name; and only well-known ports used by the Roku are supported. + ## Features * Runs under Windows (7+), macOS (10.9+), and linux @@ -35,7 +37,7 @@ VioletBug can be downloaded on Windows using either an automatic "One-Click" NSI ###### Automatic Installation -* Download `VioletBug Setup x.y.z.exe` from https://github.com/belltown/violetbug/releases/latest +* Download `VioletBug.Setup.x.y.z.exe` from https://github.com/belltown/violetbug/releases/latest * Run the downloaded file to install VioletBug. It may appear as if nothing's happening for a minute or so, depending on how your computer is configured. Be patient and the installation should complete, then VioletBug will launch * Pin the VioletBug icon to the Taskbar for convenient access, or use the desktop shortcut icon * You may have to disable your anti-virus protection (unless using only Windows Defender), before downloading and running the installer @@ -58,12 +60,12 @@ Compiled binaries and installers for various linux distributions are provided at Download `violetbug-linux.zip` from https://github.com/belltown/violetbug/releases/latest, e.g: ``` cd ~/Downloads -wget https://github.com/belltown/violetbug/releases/download/vx.y.z/violetbug.zip +wget https://github.com/belltown/violetbug/releases/download/vx.y.z/violetbug-linux.zip ``` Unzip to the appropriate folder, e.g. `/opt` ``` -sudo unzip -o -q violetbug.zip -d /opt +sudo unzip -o -q violetbug-linux.zip -d /opt ``` Run the application: @@ -79,15 +81,17 @@ Download one of the following installers: - deb package (Ubuntu/Mint/Debian, etc) - rpm package (Fedora/CentOS/Red Hat, etc) -- freebsd package (FreeBSD) - AppImage package file (multiple linux distributions) AppImage files should run on any linux distribution that supports [AppImage](http://appimage.org/): -* Set the file to be executable, e.g: `chmod u+x violetbug*.AppImage` -* Run the file, e.g: `./violetbug*.AppImage` +* First, download the .AppImage file into any directory from which you can execute applications +* Next, **set the file to be executable**, e.g: `chmod u+x violetbug*.AppImage`, or set executable file property in File Manager GUI +* Finally, run the file, e.g: `./violetbug*.AppImage` * All required dependencies and resources are contained in the `.AppImage` file. Nothing else gets installed. Run the file from any location; delete it to uninstall. +BSD variants, such as FreeBSD, are not supported. + ###### Linux dependency issues If you get this error on linux: **error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory**, then install libXScrnSaver, e.g: `sudo yum install libXScrnSaver`. @@ -149,6 +153,6 @@ File a GitHub issue at https://github.com/belltown/violetbug/issues ## Screenshots -![Rokus](https://github.com/belltown/violetbug/blob/master/doc/ScreenShotRokus.png) +![Rokus](https://raw.githubusercontent.com/belltown/violetbug/master/doc/ScreenShotRokus.png) -![Connections](https://github.com/belltown/violetbug/blob/master/doc/ScreenShotConn.png) +![Connections](https://raw.githubusercontent.com/belltown/violetbug/master/doc/ScreenShotConn.png) diff --git a/doc/BUILD.md b/doc/BUILD.md index 2d24c39..fc2e82b 100644 --- a/doc/BUILD.md +++ b/doc/BUILD.md @@ -46,6 +46,4 @@ The following commands are available to generate installers in `/dist`: | `npm run dist-appimage` | `npm run dist-deb` | `npm run dist-rpm` -| `npm run dist-freebsd` -| `npm run dist-tarxz` | `npm run dist-win` diff --git a/doc/README.md.html b/doc/README.md.html index 39191ef..3dfbc54 100644 --- a/doc/README.md.html +++ b/doc/README.md.html @@ -484,9 +484,10 @@ } -

VioletBug — Roku Debugger Graphical Interface

+

VioletBug — Roku Debugger Graphical Interface

VioletBug is a cross-platform desktop application providing a graphical interface to the Roku Debugger as an alternative to Telnet. It is similar to PurpleBug, https://belltown-roku.tk/PurpleBug, which is still supported; however, PurpleBug only runs on Windows PCs, and is closed-source. VioletBug, in contrast, is open-source running under Electron and Node.js, written entirely in HTML, CSS and JavaScript. The source code can be found on GitHub.

+

Note that VioletBug is not intended as a general-purpose Telnet client, and as such only offers features deemed to be relevant to debugging a Roku device, e.g. Rokus can only be addressed by IP address, not by host name; and only well-known ports used by the Roku are supported.

Features