From 4a352c2fcb7e9f7ce3542846217977c56996020a Mon Sep 17 00:00:00 2001 From: evilhero Date: Tue, 30 Oct 2012 14:37:56 -0300 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ad22e59..8f9be68d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Mylar is an automated Comic Book (cbr/cbz) downloader program heavily-based on the Headphones template and logic (which is also based on Sick-Beard). Please note, before you laugh hysterically at my code, I have only started learning python (<2 months ago) and this is my first 'pet project.' +Mylar is an automated Comic Book (cbr/cbz) downloader program heavily-based on the Headphones template and logic (which is also based on Sick-Beard). Yes, it does work for the most part but it is the pure definition of an 'Alpha Release'. @@ -12,11 +12,28 @@ Here are some helpful hints hopefully: (Mylar auto-creates the Comic Series directories under the Comic Location. The directory is displayed on the Comic Detail page). - If you make any Configuration changes, shutdown Mylar and restart it or else errors will occur - this is a current bug. - You need to specify a search-provider in order to get the downloads to send to SABnzbd. If you don't have either listed, choose Experimental! -- To get renaming to work (somewhat working), enable the option in the Configuration then move the ComicRN.py script located in mylar/sabnzbd to your sabnzbd/scripts directory. - Edit the file, making sure to read the documentation included and that it's correct. - In the Configuration section, if you enable 'Automatically Mark Upcoming Issues as Wanted' it will mark any NEW comic from the pullist that is on your 'watchlist' as wanted. - There are times when adding a comic it will fail with an 'Error', submit a bug and it will be checked out (usually an easy fix). +The 2 features below are extremely new and users may encounter some problems until bugs are squashed. +Please submit issues via git for any outstanding problems that need attention. + +Post-Processing + (Post-Processing has now been done to try and mimic the way SickBeard handles it.) + +- Within the sabnzbd/ folder of Mylar there are 3 files (autoProcessComics.py, autoProcessComics.cfg.sample, ComicRN.py) +- Edit (put in your Mylar host, port, login and password (if required), and ssl(0 for no, 1 for yes) and rename the autoProcessComics.cfg.sample to autoProcessComics.cfg. +- Copy autoProcessComics.py, autoProcessComics.cfg and ComicRN.py into your SABnzbd scripts directory (or wherever your SABnzbd stores it's scripts). +- Make sure SABnzbd is setup to have a 'comic-related' category that points it to the ComicRN.py script that was just moved. +- Ensure in Mylar that the category is named exactly the same. + +Renaming +- You can now specify Folder / File Formats. +- Folder Format - if left blank, it will default to just using the default Comic Directory (and creating subdirectories beneath in the format of ComicName-Year) + You can do multi-levels as well - so you could do $Publisher/$Series/$Year to have it setup like DC Comics/Batman/2011 (as an example) +- File Format - if left blank, Mylar will use the original file and not rename at all. This includes replacing spaces, and zero suppression (both renaming features). + + Please help make it better, by sending in your bug reports / enhancement requests or just say what's working for you.