From ba39c8ad5ba5b8873e92e4a79eef79c1ce1bcd18 Mon Sep 17 00:00:00 2001 From: Lewis Dexter Litanzios Date: Sat, 26 Jan 2019 08:39:05 +0100 Subject: [PATCH] Update README.md (#4534) --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11c8e2b80..6d3a7ba5c 100644 --- a/README.md +++ b/README.md @@ -455,8 +455,21 @@ To use it, please just request a free API key on [OMDb](http://www.omdbapi.com/a Please supply as much information about the problem you are experiencing as possible. Your issue has a much greater chance of being resolved if logs are supplied so that we can see what is going on. Creating an issue with '### isn't working' doesn't help anyone to fix the problem. ## Contributing -All contributions are welcome just send a pull request. Jackett's framework allows our team (and any other volunteering dev) to implement new trackers in an hour or two. If you'd like support for a new tracker but are not a developer then feel free to leave a request on the [issues page](https://github.com/Jackett/Jackett/issues). It is recommended to use Visual Studio 2017 when making code changes in this project. You can download the community version for free [here](https://www.visualstudio.com/downloads/). +Jackett's framework typically allows our team and volunteering developers to implement new trackers in a couple of hours + +Depending on logic complexity, there are two common ways new trackers are implemented: + +1. simple [definitions](http://github.com/Jackett/Jackett/tree/master/src/Jackett.Common/Definitions) (.yml / YAML), and; +2. advanced (native) [indexers](http://github.com/Jackett/Jackett/tree/master/src/Jackett.Common/Indexers) (.cs / C#) + +Read more about the [simple definition format](https://github.com/Jackett/Jackett/wiki/Definition-format). + +If you are a developer then it's recommended to download the free community version of [Visual Studio](http://visualstudio.com) + +If you are not a developer and would like a (new) tracker supported then feel free to leave an [issue](https://github.com/Jackett/Jackett/issues) request. + +All contributions are welcome just send a pull request. ## Building from source