diff --git a/CHANGES.md b/CHANGES.md index a37a3315..163f1d91 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -107,6 +107,7 @@ * Change label "Show is grouped in" in edit show page to "Show is in group" and move the section higher * Fix post processing of anime with version tags * Change accept SD titles that contain audio quality +* Change readme.md [develop changelog] * Update Requests library 2.7.0 (ab1f493) to 2.7.0 (8b5e457) diff --git a/readme.md b/readme.md index 34fedc0c..f2157151 100644 --- a/readme.md +++ b/readme.md @@ -1,41 +1,114 @@ -SickGear -===== +
+
SickGear
+**SickGear**, a usenet and bittorrent PVR +
+SickGear is Beta software. *Please note that this software is not for the masses*. We require you to be knowledgeable about how to use git and setup basic requirements in order to run this software. Please use a search engine if you are unsure how to perform a task, before asking us about it! *If this is __not__ for you, then please do not use this software!* -SickGear is a Video File Manager for TV Shows, It watches for new episodes of your favorite shows and when they are posted it does its magic. +SickGear provides management of TV shows and/or Anime, can detect wanted or episodes to upgrade and make use of downloader applications. SickGear is proud to be a descendant of SickBeard and is honoured to be endorsed by one of its former lead developers. -*SickGear is currently in beta release stage. There may be severe bugs in it and at any given time it may not work at all.* +## Features include +* Stable, quality assured testing and development cycle +* Innovations that inspire imitators +* Most comprehensive selection of usenet and torrent sources +* Episode management + * View missed and upcoming shows at a glance with "day by day" and other layouts + * Group shows into personalised sections in a full show list view + * Automatic and manual search for availability of wanted episodes + * Set what episodes you want and how to receive them + * Uses well known established index sites to gather show information + * Searches for known alternatively named shows with a fallback to user edited names + * Searches for known alternatively numbered episodes with a fallback to user edited numbers + * Forward search results to a downloader program (e.g. SABNZBd, NZBGet, uTorrent, and others) + * Save search results to a "blackhole" folder that can be periodically scanned for taking action + * Post-process downloaded episodes into customisable layouts, with or without extra metadata + * Advanced Failed Download Handling (FDH) + * Overview of seasons, episodes, rating, version, airdate, episode status ([their meaning](https://github.com/SickGear/SickGear/wiki/Episode-Status)) +* Subtitle management +* Notification + * System notifiers (i.e. XBMC, Kodi, Plex) + * Device notifiers (i.e. Growl, Prowl, Notify My Android) + * Social (i.e. Twitter, E-mail) +* Server friendly with minimal number of calls (e.g. one request per chosen snatch, not per result) +* Let SickGear recommend trendy shows -There are currently a lot of changes that we're working on, which affect the very core of how SickGear works. We're doing this to lay the groundwork -for making SickGear seriously more awesome, scalable and resource-friendly than it already is. - -While we're doing this, please expect SickGear do strange things, or maybe even not work at all. In any case, we need your help. If you see SickGear behaving weird, check if someone has reported it, and if not, open a new issue. There is little to no use to report "software should be stable". We will focus on that later, not now. +Some of our innovative features; +* Automated search after adding a show +* Desktop notifications +* Enhanced Anime features when adding shows +* Visual percentage progress of managed episodes +* Separate Plex server and Plex client settings +* Intelligent library updates that target Plex servers that list the show of an episode +* Configurable episode status for removed media files +* Configurable default home page +* Source providers +* User Interface -!!! Please before using this with your existing database (sickbeard.db) please make a backup copy of it and delete any other database files such as cache.db and failed.db if present, we HIGHLY recommend starting out with no database files at all to make this a fresh start but the choice is at your own risk !!! +## Available versions + + + + + + + + +
Master(most stable)
Development(mostly stable)
-FEATURES: -- XBMC library updates, poster/fanart downloads, and NFO/TBN generation -- configurable episode renaming -- available for any platform, uses simple HTTP interface -- can notify XBMC, Growl, or Twitter when new episodes are available -- specials and double episode support -- Automatic XEM Scene Numbering/Naming for seasons/episodes -- Episode Status Manager now allows for mass failing seasons/episodes to force retrying. -- DVD Order numbering for returning the results in DVD order instead of Air-By-Date order. -- Improved Failed handling code for shows. -- DupeKey/DupeScore for NZBGet 12+ -- Searches both TheTVDB.com, TVRage.com and AniDB.net for shows, seasons, episodes -- Importing of existing video files now allows you to choose which indexer you wish to have SickBeard search its show info from. -- Your tvshow.nfo files are now tagged with a indexer key so that SickBeard can easily tell if the shows info comes from TheTVDB or TVRage. -- Sports shows are now able to be searched for.. +## Required software +* Python 2.6+ +* Cheetah 2.1.0+ -## Dependencies +## Howto -To run SickGear from source you will need Python 2.6+ and Cheetah 2.1.0+. +#### Install +* [Ubuntu](https://github.com/SickGear/SickGear/wiki/Install-SickGear-[1]-Ubuntu) +* [CentOS / RHEL / Fedora](https://github.com/SickGear/SickGear/wiki/Install-SickGear-[2]-CentOS-RHEL) +* [Arch Linux](https://github.com/SickGear/SickGear/wiki/Install-SickGear-[3]-Arch-Linux) +* [Synology](https://github.com/SickGear/SickGear/wiki/Install-SickGear-[4]-Synology) -## Forums +#### Contribute code +Please read through our [guide](https://github.com/SickGear/SickGear/wiki/%5BHow-to%5D-Contribute-Code). Included are directions for coding in git and how to submit pull requests. +Moreover, if your pull request is about a new feature, please try not to use more than 200 characters explaining its function. Instead, talk to our devs in our IRC channel (link below). -Any questions or setup info your looking for can be found at our [wiki](https://github.com/SickGear/SickGear/wiki) -
-If you find a bug please report at our [SickGear IRC channel](http://webchat.freenode.net/?channels=SickGear) -
-Be sure to provide a SickGear log at pastebin.com in debug mode where the error is evidence or it'll never get fixed. +#### Report issues +As reported issues can get messy, we've set up a few [guidelines](https://github.com/SickGear/SickGear/wiki/%5BHow-to%5D-Report-Issues) so that we can quickly get to the heart of the issue that is reported. Please note that we require all the information in there! Any missing information might result in the reported issue being denied! + +## Contributors + +#### Core code +A huge shout out goes to the following people; MidgetSpy, zoggy, 1337, Tolstyak, Mr_Orange, Bricky, JackDandy, adam111316, Supremicus, Prinz23, and ressu (zanaga) + +#### Other things, testers and QA +Also, warm thanks to tehspede, CtrlAltDefeat, vergessen (betrayed), Mike, and Rawh for their keen eye, all around help, and making sure all manner of things work as expected ( mostly! :) ) + +#### Provider code +Thanks also, to the unsung heroes that added source providers; Idan Gutman, Daniel Heimans, jkaberg, and Seedboy + +Finally, a massive thanks to all those that remain in the shadows, the quiet ones that welcome folk to special places, we salute you for your hospitality and for tirelessly keeping up operations. + +## Community +* Support + * Please note that, aside from bug reports, we do *not* offer support. We can offer some help, but we really need you to understand the basics of your Linux or Windows OS. If you do not understand basics such as locating a database file, not running as root, setting up file permissions, or claiming a user derp, then we really cannot help you! + * IRC: `irc.freenode.net` channel `#SickGear` + * Webchat IRC: [webchat link](http://webchat.freenode.net/?channels=SickGear) + +## Screenies + + + + + + + + + + + + + + + + + + +
Show List: Simple
Theme: Dark, Light		Show List: Banner
Theme: Dark, Light		Show List: Poster
Theme: Dark 1, Dark 2		Episode View: Day by Day
Theme: Dark, Light		Episode View: List
Theme: Dark 1, Dark 2, Light		Display Show
Theme: Dark, Light