From d68fe420e7bf18b6d519c9c8b267b46cfa0b955b Mon Sep 17 00:00:00 2001 From: SickGear Date: Sun, 13 Mar 2016 02:39:59 +0000 Subject: [PATCH] Change simplify and clarify some points. --- readme.md | 116 +++++++++++++++++++++++++++++------------------------- 1 file changed, 62 insertions(+), 54 deletions(-) diff --git a/readme.md b/readme.md index 63095a3a..151d8872 100644 --- a/readme.md +++ b/readme.md @@ -2,13 +2,19 @@
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!* +*Please note you should know how to use git and setup basic requirements in order to run this software.* -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 provides management of TV shows and/or Anime, it can detect new episodes, link to downloader apps, and more. SickGear is a proud descendant of Sick Beard and is humbled to have been endorsed by one of its former lead developers. +Why SickGear? +* SickGear maintains perfect uptime with the longest track record of being stable, reliable and trusted to work +* SickGear delivers quality from active development with a wealth of options on a dark or light themed interface +* [Migrating](https://github.com/SickGear/SickGear/wiki/Install-SickGear-%5B0%5D-Migrate) to a hassle free and feature rich set up is super simple + ## Features include * Stable, quality assured testing and development cycle * Innovations that inspire imitators +* Compatible with any platform via a familiar web interface * 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 @@ -18,18 +24,21 @@ SickGear provides management of TV shows and/or Anime, can detect wanted or epis * 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 (e.g. SABNZBd, NZBGet, uTorrent, and others) + * Searches for known alternatively numbered seasons with a fallback to user edited numbers + * Forward search results to a downloader (e.g. NZBGet, SABNZBd, 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)) + * Overview of seasons, episodes, rating, version, airdate, episode status ([their meaning](https://github.com/SickGear/SickGear/wiki/Status-Modes)) +* Processing nzb/torrents with your downloader application at your chosen qualities * Subtitle management * Notification - * System notifiers (i.e. XBMC, Kodi, Plex) + * System notifiers (i.e. Kodi, Emby, Plex, XBMC) * 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 +* Can recommend trendy and/or personally tailored shows from Trakt, IMDb, AniDB +* Automated alternative show names and episode numbering from XEM Some of our innovative features; * Automated search after adding a show @@ -43,54 +52,6 @@ Some of our innovative features; * Source providers * User Interface -## Available versions - - - - - - - - -
Master(most stable)
Development(mostly stable)
- -## Required software -* Python 2.7.9+ (earlier versions must be used with a current version of openssl) -* Cheetah 2.1.0+ - -## Howto - -#### 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) - -#### 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). - -#### 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` - ## Screenies @@ -100,6 +61,8 @@ Finally, a massive thanks to all those that remain in the shadows, the quiet one + + @@ -108,6 +71,51 @@ Finally, a massive thanks to all those that remain in the shadows, the quiet one + +
Show List: Simple
Theme: Dark, Light		Episode View: Day by Day
Theme: Dark, Light		 Episode View: List
Theme: Dark, Dark 2, Light		 Display Show
Theme: Dark, Light		Add from Trakt
Theme: Dark		Edit Show
Theme: Dark
+ +## Available versions + + + + + + + + + + + +
Master (changes)(most stable)
Development (changes)(mostly stable)
[ ++ Install Guides ++ ][ Frequently Answered ][ Discover Wiki ]
+ +## Howto + +#### Report issues +The following [guidelines](https://github.com/SickGear/SickGear/wiki/%5BHow-to%5D-Report-Issues) prevent reported issues getting messy and help us quickly get to the nub of an issue. Please be aware that we require all requested information and that missing details will likely result in the reported issue being closed. + +#### Contribute code +Please read this [guide](https://github.com/SickGear/SickGear/wiki/%5BHow-to%5D-Contribute-Code). Directions include coding with git and submitting pull requests. +If your pull request is a new feature, please try explaining its function to a limit of 200 characters. Better, talk to our devs in IRC (details below). + +## Contributors + +#### To core +MidgetSpy, zoggy, 1337, Tolstyak, Mr_Orange, Bricky, JackDandy, Prinz23, Supremicus, adam111316, and zanaga + +#### In other areas, testers and QA +Warm thanks to tehspede, CtrlAltDefeat, Mike, vergessen (betrayed), and Rawh for their keen eye, all around help, and making sure all manner of things work as expected + +#### Provider code +Thanks also, to 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 who welcome folk to special places, we salute you for your hospitality and for tirelessly keeping up operations. + +## Community +* IRC: `irc.freenode.net` channel `#SickGear` + Support is available, but you should understand the basics of your Linux or Windows OS. If you don't understand basics like locating a db file, not running as root, or things like setting file permissions, then SickGear might not be for you. + +--- +Enjoy SickGear - stability, reliability, assured.