diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 00000000..7f2945fa --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,22 @@ +#### Branch: The name of the branch (e.g. master or develop) +#### Branch version commit hash: (See the About page) + + +Expectation | Result +------------ | ------------- +Your expectation paragraph(s) text here. Before the bar >> | then, your result paragraph(s) text here. + + +**Steps to reproduce:** +*1)* Step to take +*2)* Step to take +... + + +Either a link to gist (best as they are easily deleted) or log text wrapped in "pre" tags + + +Additional notes: +For example, any relevant config settings that may be help us replicate the reported issue + +Targeting your info so that the issue can be reproduced is the single fastest way to get it resolved diff --git a/readme.md b/readme.md index 7e06a71a..28b9c29c 100644 --- a/readme.md +++ b/readme.md @@ -2,15 +2,15 @@
SickGear
**SickGear**, a usenet and bittorrent PVR
-*Please note you should know how to use git and setup basic requirements in order to run 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, 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/wiki/Install-SickGear-%5B0%5D-Migrate) to a hassle free and feature rich set up is super simple - +* [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 @@ -29,13 +29,13 @@ Why SickGear? * 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/wiki/Status-Modes)) + * 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. Kodi, Emby, Plex, XBMC) - * Device notifiers (i.e. Growl, Prowl, Notify My Android) - * Social (i.e. Twitter, E-mail) + * Home Theater/NAS (Emby, Kodi, Plex, Syno, Tivo, and more) + * Social notifiers (Trakt, Slack, Gitter, Discord, E-mail, and more) + * Device notifiers (Boxcar2, Notify My Android, Growl, Prowl, and more) * Server friendly with minimal number of calls (e.g. one request per chosen snatch, not per result) * Can recommend trendy and/or personally tailored shows from Trakt, IMDb, AniDB * Automated alternative show names and episode numbering from XEM @@ -55,24 +55,24 @@ Some of our innovative features; ## Screenies - - - - - - - - + + + + + + + + - - - - - - - - + + + + + + + +
Show List: Simple
Theme: Dark, Light		Show List: Banner
Theme: Dark, Light		Show List: Poster
Theme: Dark, Dark 2		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		Show List: Simple
Theme: Dark, Light		Show List: Banner
Theme: Dark, Light		Show List: Poster
Theme: Dark, Dark 2		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
@@ -80,13 +80,13 @@ Some of our innovative features; ## Available versions - + - + - +
Master (changes)(most stable)Master (changes)(most stable)
Development (changes)(mostly stable)Development (changes)(mostly stable)
[ ++ Install Guides ++ ][ Frequently Answered ][ Discover Wiki ][ ++ Install Guides ++ ][ Frequently Answered ][ Discover Wiki ]
@@ -94,10 +94,10 @@ Some of our innovative features; ## Howto #### Report issues -The following [guidelines](https://github.com/SickGear/SickGear.Wiki/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. +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/wiki/%5BHow-to%5D-Contribute-Code). Directions include coding with git and submitting pull requests. +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 @@ -114,8 +114,10 @@ Thanks also, to unsung heroes that added source providers; Idan Gutman, Daniel H 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. +* web based (most likely one on one with a dev) +*  (`irc.freenode.net` channel `#SickGear`) + +Although support is available, 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.