diff --git a/README.md b/README.md index b9a79e84..c1138fff 100755 --- a/README.md +++ b/README.md @@ -135,26 +135,29 @@ It will also install the following python libraries that are required for certai * [MLB-StatsAPI](https://pypi.org/project/MLB-StatsAPI/): The main library that fetches and parses all of the actual MLB data being displayed * [RGBMatrixEmulator](https://github.com/ty-porter/RGBMatrixEmulator): The emulation library for the matrix display. Useful for running on MacOS or Linux, or for development. -#### Installation on Non-Raspberry Pi Hardware +#### Customizing the Installation -The installation script is designed for physical hardware. When attempting to install it on other platforms, you should not use `sudo` to install the dependencies. In addition, you can pass the `--emulator-only` argument to skip installation steps that aren't required. +Additional flags are available for customizing your install: ``` -sh install.sh --emulator-only -``` +-a, --skip-all Skip all dependencies and config installation (equivalent to -c -p -m). +-c, --skip-config Skip updating JSON configuration files. +-m, --skip-matrix Skip building matrix driver dependency. Video display will default to emulator mode. +-p, --skip-python Skip Python 3 installation. Requires manual Python 3 setup if not already installed. -Additional flags are available for customizing your install: +-v, --no-venv Do not create a virtual environment for the dependencies. +-e, --emulator-only Do not install dependencies under sudo. Skips building matrix dependencies (equivalent to -m) +-d, --driver Specify a branch name or commit SHA for the rpi-rgb-led-matrix library. (Defaults to "$DRIVER") +-h, --help Display this help message ``` --p, --skip-python Skips Python 3 installation. You will need to install it via your platform's appropriate package manager. --m, --skip-matrix Skips RPI-specific matrix driver installation and build. --c, --skip-config Skips default config overwrite without prompting. --a, --skip-all Performs all above skips. ---no-venv Do not create a virtual environment for the dependencies. ---emulator-only Do not install dependencies under sudo. Skips building matrix dependencies. +#### Installation on Non-Raspberry Pi Hardware + +The installation script is designed for physical hardware. When attempting to install it on other platforms, you should not use `sudo` to install the dependencies. In addition, you can pass the `--emulator-only` argument to skip installation steps that aren't required. --h, --help Displays help +``` +sh install.sh --emulator-only ``` #### Updating @@ -258,7 +261,6 @@ A default `config.json.example` file is included for reference. Copy this file t "pregame_weather" Bool If enabled, will display the weather for the game's location on the pregame screen. "debug" Bool Game and other debug data is written to your console. "demo_date" String A date in the format YYYY-MM-DD from which to pull data to demonstrate the scoreboard. A value of `false` will disable demo mode. -"driver_version" String A branch name or commit SHA for the installed rpi-rgb-led-matrix library. Falls back to "master" if not present. ``` ### Delaying Board Update diff --git a/config.json.example b/config.json.example index 321bbf3f..fb159e6e 100644 --- a/config.json.example +++ b/config.json.example @@ -48,6 +48,5 @@ "pregame_weather": true, "scrolling_speed": 2, "debug": false, - "demo_date": false, - "driver_version": "14ab2ff" + "demo_date": false } diff --git a/install.sh b/install.sh index 12c9e745..42e03166 100755 --- a/install.sh +++ b/install.sh @@ -1,58 +1,65 @@ #!/bin/bash +SKIP_PYTHON=false +SKIP_CONFIG=false +SKIP_MATRIX=false +NO_SUDO=false +SKIP_VENV=false +DRIVER=14ab2ff + usage() { cat <