From 2675f8e2da6bda6e395f6b230cedbd6239054988 Mon Sep 17 00:00:00 2001 From: Deathbybandaid Date: Mon, 5 Oct 2020 08:54:57 -0400 Subject: [PATCH] Created Installation (markdown) --- Installation.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 Installation.md diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..43b3ba3 --- /dev/null +++ b/Installation.md @@ -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. \ No newline at end of file