mirror
/
mylar
mirror of https://github.com/evilhero/mylar
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md 

Fixed some typos.
This commit is contained in:
Michael 2016-05-31 23:20:04 -07:00 committed by evilhero
parent fe1832e067
commit 305efa3cbc
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,9 +1,9 @@
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). 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, yes there are still bugs, and for that reson I still consider it the definition of an 'Alpha Release'. Yes, it does work, yes there are still bugs, and for that reason I still consider it the definition of an 'Alpha Release'.
-REQUIREMENTS- -REQUIREMENTS-
- at least version 2.7.9 Python for proper usage (3.x is not supported). - At least version 2.7.9 Python for proper usage (3.x is not supported).
** NEW ** ** NEW **
You will need to get your OWN ComicVine API Key for this application to fully work. You will need to get your OWN ComicVine API Key for this application to fully work.
@ -11,7 +11,7 @@ Yes, it does work, yes there are still bugs, and for that reson I still consider
To start it, type in 'python Mylar.py' from within the root of the mylar directory. Adding a --help option to the command will give a list of available options. To start it, type in 'python Mylar.py' from within the root of the mylar directory. Adding a --help option to the command will give a list of available options.
Once it's started, navigate to to localhost:8090 in your web browser (or whatever IP the machine that has Mylar is on). Once it's started, navigate to localhost:8090 in your web browser (or whatever IP the machine that has Mylar is on).
Here are some helpful hints hopefully: Here are some helpful hints hopefully:
- Add a comic (series) using the Search button, or using the Pullist. - Add a comic (series) using the Search button, or using the Pullist.
@ -19,7 +19,7 @@ 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). (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 an outstanding bug. - If you make any Configuration changes, shutdown Mylar and restart it or else errors will occur - this is an outstanding bug.
- You need to specify a search-provider in order to perform any search-related function! - You need to specify a search-provider in order to perform any search-related function!
- 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. - 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). - 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).
- For the most up-to-date build, use the Development build. Master doesn't get updated as frequently (> month), and Development is usually fairly stable. - For the most up-to-date build, use the Development build. Master doesn't get updated as frequently (> month), and Development is usually fairly stable.
@ -33,7 +33,7 @@ Post-Processing
- Within the post-processing/ folder of Mylar there are 2 files (autoProcessComics.py and autoProcessComics.cfg.sample) - Within the post-processing/ folder of Mylar there are 2 files (autoProcessComics.py and autoProcessComics.cfg.sample)
- Within the post-processing/ folder of Mylar there are 2 directories (nzbget, sabnzbd) and within each of these client folders, is a ComicRN.py script that is to be used with the respective download client. - Within the post-processing/ folder of Mylar there are 2 directories (nzbget, sabnzbd) and within each of these client folders, is a ComicRN.py script that is to be used with the respective download client.
- 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. - 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 the respective ComicRN.py into your SABnzbd/NZBGet scripts directory (or wherever your download client stores it's scripts). - Copy autoProcessComics.py, autoProcessComics.cfg and the respective ComicRN.py into your SABnzbd/NZBGet scripts directory (or wherever your download client stores its scripts).
- Make sure SABnzbd/NZBGet is setup to have a 'comic-related' category that points it to the ComicRN.py script that was just moved. - Make sure SABnzbd/NZBGet 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. - Ensure in Mylar that the category is named exactly the same.