1
0
mirror of https://github.com/fHDHR/fHDHR_NextPVR.git synced 2025-12-06 09:36:59 -05:00

Created Installation (markdown)

Deathbybandaid 2020-10-05 08:54:57 -04:00
parent fd20ab8d7c
commit 2675f8e2da

35
Installation.md Normal file

@ -0,0 +1,35 @@
As this should be able to run multi-platform, and later on in docker, these instructions are for general usage.
Platform specific instructions may be added later.
# python
Install python3 and python3-pip. There will be no support for python2.
# ffmpeg
Install ffmpeg.
Verify that it is available in PATH. This can be achieved by running `ffmpeg -version` in your terminal/CLI.
If you wish, there is a configuration option to manually set the ffmpeg path.
# Download the script
Download the zip, or git clone.
# python requirements
Navigate into your script directory and run `pip3 install -r requirements.txt`
# Configuration
Copy the included `config.example.ini` file to a known location.
The script will not run without this. There is no default configuration file location.
Modify the configuration file to suit your needs.
There is an additional `config.all.ini` file that will contain *ALL* of the configuration options.
The example configuration file will be all that you need to use this script.
# Run
`python3 main.py --config_file=` and the path to the config file.
The script will NOT look for a default config file location.