jbinkley60 / plugin.program.kscleaner

GNU General Public License v2.0
10 stars 2 forks source link

Suggestion: Readme should include instructions for installation and use #5

Open mrobe opened 7 months ago

mrobe commented 7 months ago

Would be nice if the Readme explained a little more, e.g.,

Installation

Kodi Selective Cleaner is not in the Kodi repository, because Team Kodi doesn't allow add-ons which do direct database calls, which are required for this to operate.

To install, you need to download the ZIP file directly from this repository (i.e., select Code > Download ZIP), place the downloaded file into a source directory for your Kodi installation, and then use Add-ons > Install from zip file in the Kodi Add-ons manager.

Usage

...


Rationale for this suggestion: https://blog.codinghorror.com/if-it-isnt-documented-it-doesnt-exist/

jbinkley60 commented 7 months ago

Thanks for the suggestion. I am beginning work on version 1 .0.6 and will include this as well as adding a page to the Wiki on Installation.

jbinkley60 commented 7 months ago

I'll leave this issue open as a reminder to me until v1.0.6 is actually released. Your suggestions are planned for it.

cyberbrix commented 5 months ago

Came to offer a +1 for this suggestion. It was the first thing I looked for. (I know how to install add ons, but it's always good to have instructions)