diff --git a/DEVGUIDE.md b/DEVGUIDE.md index 6652b153b..e644fca1f 100644 --- a/DEVGUIDE.md +++ b/DEVGUIDE.md @@ -5,6 +5,7 @@ Follow the steps below to install the app on your personal Roku device. This wil - [Dev Guide For The Jellyfin Roku App](#dev-guide-for-the-jellyfin-roku-app) - [Developer Mode](#developer-mode) - [Clone the GitHub Repo](#clone-the-github-repo) + - [Install Dependencies](#install-dependencies) - [Method 1: Visual Studio Code](#method-1-visual-studio-code) - [Install VSCode](#install-vscode) - [Usage](#usage) @@ -12,7 +13,6 @@ Follow the steps below to install the app on your personal Roku device. This wil - [Method 2: Sideload to Roku Device Manually](#method-2-sideload-to-roku-device-manually) - [Method 3: Direct load to Roku Device](#method-3-direct-load-to-roku-device) - [Login Details](#login-details) - - [Install Necessary Packages](#install-necessary-packages) - [Deploy](#deploy) - [Bug/Crash Reports](#bugcrash-reports) - [Upgrade](#upgrade) @@ -43,10 +43,19 @@ Open up the new folder: cd jellyfin-roku ``` -Install Dependencies: +## Install Dependencies + +You'll need [`npm`](https://github.com/npm/cli), [`make`](https://www.gnu.org/software/make) and [`curl`](https://curl.se). + +For Debian or Ubuntu, install it via: + +```bash +sudo apt-get install npm make curl +``` + +Then, use `npm` to install more dependencies ```bash -sudo apt-get install npm npm install ``` @@ -86,10 +95,6 @@ Example: Install Necessary Packages -```bash -sudo apt-get install make -``` - Build the package ```bash @@ -111,12 +116,6 @@ export ROKU_DEV_PASSWORD=password Normally you would have to open up your browser and upload a .zip file containing the app code. These commands enable the app to be zipped up and installed on the Roku automatically which is essential for developers and makes it easy to upgrade in the future for users. -### Install Necessary Packages - -```bash -sudo apt-get install make curl -``` - ### Deploy Package up the application, send it to your Roku, and launch the channel: @@ -129,7 +128,7 @@ Note: You only have to run this command once if you are not a developer. The Jel ## Bug/Crash Reports -Did the app crash? Find a nasty bug? Use the this command to view the error log and [report it to the developers](https://github.com/jellyfin/jellyfin-roku/issues): +Did the app crash? Find a nasty bug? Use this command to view the error log and [report it to the developers](https://github.com/jellyfin/jellyfin-roku/issues): ```bash telnet ${ROKU_DEV_TARGET} 8085 @@ -137,6 +136,12 @@ telnet ${ROKU_DEV_TARGET} 8085 To exit telnet: `CTRL + ]` and then type `quit + ENTER` +If you setup `ROKU_DEV_TARGET` as in [Method 3](#method-3-direct-load-to-roku-device), you can also take a screenshot of the app + +```bash +make screenshot +``` + ## Upgrade Navigate to the folder where you installed the app then upgrade the code to the latest version: @@ -157,12 +162,6 @@ Modify code -> `make install` -> Use Roku remote to test changes -> `telnet ${RO Unfortunately there is no debugger. You will need to use telnet to see log statements, warnings, and error reports. You won't always need to telnet into your device but the workflow above is typical when you are new to BrightScript or are working on tricky code. -Install necessary packages: - -```bash -sudo apt-get install nodejs npm -``` - ## Committing Before committing your code, please run: @@ -177,10 +176,12 @@ This will format your code and run the CI checks locally to ensure you will pass This repo already contains all necessary images for the app. This script only needs to be run when the [official Jellyfin images](https://github.com/jellyfin/jellyfin-ux) are changed to allow us to update the repo images. -Install necessary packages: +You'll need `convert`, from [ImageMagick](https://imagemagick.org) + +For Debian or Ubuntu, install it via: ```bash -sudo apt-get install curl imagemagick +sudo apt-get install imagemagick ``` Download and convert images: diff --git a/dictionary.txt b/dictionary.txt index 8efe014ba..9d6b8e8d4 100644 --- a/dictionary.txt +++ b/dictionary.txt @@ -5,6 +5,7 @@ sideload Sideload Reddit DEVGUIDE +ImageMagick ing hardcode Hardcoding @@ -15,4 +16,4 @@ Repo dev Dev assignees -HTTPS \ No newline at end of file +HTTPS