Fix config file and update ReadMe

lasley · Oct 26, 2015 · 3ac444c · 3ac444c
1 parent 36f9493
commit 3ac444c
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 *   [Install Node.js and CoffeeScript](https://blog.dlasley.net/2014/04/installing-node-js-and-coffeescript/)
 *   Install libudev-dev (to monitor disc drives for changes)
 *   Install NodeMakemkv - `npm install node-makemkv/`
-*   Edit the `[settings]` section of `server_settings.ini` per the below specifications:
+*   Edit the `[settings]` section of `settings.json` per the below specifications:
 
 Variable | Description
 ---------|-------------
@@ -25,6 +25,14 @@ Variable | Description
 
 *   Clone the repo - `git clone https://github.com/lasley/node-makemkv.git`
 
+*   Install dependencies with npm - `npm install ./node-makemkv`
+
+*   Copy the example settings file to the correct location - `cp ./node-makemkv/settings.example.json ./node-makemkv/settings.json`
+
+*   Copy the example profile to the correct location - `cp ./node-makemkv/conversion_profile_example.xml ./node-makemkv/conversion_profile.xml`
+
+*   Update the `conversion_profile` path in `settings.json`
+
 *   Run the server – `coffee ./node-makemkv/server.coffee` – _Note: you must run the server as a user that has permissions to read from optical media_
 
 *   Navigate to `SERVER_HOSTNAME:LISTEN_PORT` to view the GUI

diff --git a/settings.example.json b/settings.example.json
@@ -1,7 +1,8 @@
 {
     "USER_SETTINGS": {
-        "output_dir": "/media/Motherload/nodemkv",
-        "source_dir": "/media/Motherload/test-backups",
+        "output_dir": "/path/to/nodemakemkv/output",
+        "source_dir": "/path/to/browse/directory",
+        "conversion_profile": "/path/to/conversion/profile.xml",
         "listen_port": 1337,
         "makemkvcon_path": "/usr/bin/makemkvcon",
         "outlier_modifier": 0.7,
@@ -16,45 +17,45 @@
         ]
     },
     "attribute_ids": {
-        0: "Unknown",
-        1: "Type",
-        2: "name",
-        3: "Lng Code",
-        4: "Lng Name",
-        5: "Codec ID",
-        6: "Codec Short",
-        7: "Codec Long",
-        8: "Chapter Count",
-        9: "Duration",
-        10: "Disk Size",
-        11: "Disk Size Bytes",
-        12: "Stream Type Extension",
-        13: "Bitrate",
-        14: "Audio Channels Cnt",
-        15: "Angle Info",
-        16: "Source File Name",
-        17: "Audio Sample Rate",
-        18: "Audio Sample Size",
-        19: "Video Size",
-        20: "Video Aspect Ratio",
-        21: "Video Frame Rate",
-        22: "Stream Flags",
-        23: "Date Time",
-        24: "Original Title ID",
-        25: "Segments Count",
-        26: "Segments Map",
-        27: "Output Filename",
-        28: "Metadata Lng Code",
-        29: "Metadata Lng Name",
-        30: "Tree Info",
-        31: "Panel Title",
-        32: "Volume Name",
-        33: "Order Weight",
-        34: "Output Format",
-        35: "Output Format Description",
-        36: "MaxValue",
-        37: "ap_iaPanelText",
-        38: "ap_iaMkvFlags",
-        39: "ap_iaMkvFlagsText"
+        "0": "Unknown",
+        "1": "Type",
+        "2": "name",
+        "3": "Lng Code",
+        "4": "Lng Name",
+        "5": "Codec ID",
+        "6": "Codec Short",
+        "7": "Codec Long",
+        "8": "Chapter Count",
+        "9": "Duration",
+        "10": "Disk Size",
+        "11": "Disk Size Bytes",
+        "12": "Stream Type Extension",
+        "13": "Bitrate",
+        "14": "Audio Channels Cnt",
+        "15": "Angle Info",
+        "16": "Source File Name",
+        "17": "Audio Sample Rate",
+        "18": "Audio Sample Size",
+        "19": "Video Size",
+        "20": "Video Aspect Ratio",
+        "21": "Video Frame Rate",
+        "22": "Stream Flags",
+        "23": "Date Time",
+        "24": "Original Title ID",
+        "25": "Segments Count",
+        "26": "Segments Map",
+        "27": "Output Filename",
+        "28": "Metadata Lng Code",
+        "29": "Metadata Lng Name",
+        "30": "Tree Info",
+        "31": "Panel Title",
+        "32": "Volume Name",
+        "33": "Order Weight",
+        "34": "Output Format",
+        "35": "Output Format Description",
+        "36": "MaxValue",
+        "37": "ap_iaPanelText",
+        "38": "ap_iaMkvFlags",
+        "39": "ap_iaMkvFlagsText"
     }
-}
+}