From 8e1294b5a0853d7aedd034cd3f581bc8aadd711a Mon Sep 17 00:00:00 2001 From: desimaniac <5501908+desimaniac@users.noreply.github.com> Date: Mon, 3 Jun 2019 22:02:55 -0500 Subject: [PATCH] Readme: Tweaked. --- README.md | 72 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 52 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 193beaf..98dfb87 100644 --- a/README.md +++ b/README.md @@ -96,33 +96,67 @@ Click to enlarge. # Requirements -1. Ubuntu/Debian +1. Debian OS (can work in other operating systems as well). -2. Python 3.5 or higher (`sudo apt install python3 python3-pip`). +2. Python 3.5+ + +3. Required Python modules. -3. requirements.txt modules (see below). # Installation ## 1. Base Install -Install Traktarr to be run with `traktarr` command: +Installs Traktarr to the system so that it can be ran with the `traktarr` command. + + +1. Clone the Traktarr repo. + + ``` + sudo git clone https://github.com/l3uddz/traktarr /opt/traktarr + ``` -1. `cd /opt` +1. Fix permissions of the `traktarr` folder (replace `user`/`group` with your info; run `id` to check). + + ``` + sudo chown -R user:group /opt/traktarr + ``` -2. `sudo git clone https://github.com/l3uddz/traktarr` +1. Go into the `traktarr` folder. -3. `sudo chown -R user:group traktarr` (run `id` to find your user / group) + ``` + cd /opt/traktarr + ``` -4. `cd traktarr` +1. Install Python and PIP. -5. `sudo python3 -m pip install -r requirements.txt` + ``` + sudo apt-get install python3 python3-pip + ``` -6. `sudo ln -s /opt/traktarr/traktarr.py /usr/local/bin/traktarr` +1. Install the required python modules. -7. `traktarr run` - run once to generate a sample a config.json file. + ``` + sudo python3 -m pip install -r requirements.txt + ``` -8. `nano config.json` - edit preferences. +1. Create a shortcut for `traktarr`. + + ``` + sudo ln -s /opt/traktarr/traktarr.py /usr/local/bin/traktarr + ``` + +1. Generate a basic `config.json` file. + + ``` + traktarr run + ``` + +1. Configure the `config.json` file. + + ``` + nano config.json + ``` ## 2. Create a Trakt Application @@ -134,15 +168,13 @@ Install Traktarr to be run with `traktarr` command: 4. Click "SAVE APP". -5. Open the Traktarr configuration file `config.json` and insert the Client ID in the `client_id` and the Client Secret in the `client_secret`, like this: +5. Open the Traktarr configuration file `config.json` and insert your Trakt Client ID in the `client_id` and your Trakt Client Secret in the `client_secret`, like this: - ``` - { - "trakt": { - "client_id": "my_client_id", - "client_secret": "my_client_secret_key" - } - } + ```json + "trakt": { + "client_id": "your_trakt_client_id", + "client_secret": "your_trakt_client_secret" + } ``` ## 3. Authenticate User(s) (optional)