From 6f683a71c79c94d82e26b6214497e83654364fd8 Mon Sep 17 00:00:00 2001 From: "beville@gmail.com" Date: Thu, 14 Feb 2013 19:09:13 +0000 Subject: [PATCH] added readme for script folder git-svn-id: http://comictagger.googlecode.com/svn/trunk@503 6c5673fe-1810-88d6-992b-cd32ca31540c --- scripts/README.txt | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 scripts/README.txt diff --git a/scripts/README.txt b/scripts/README.txt new file mode 100644 index 0000000..5b92c57 --- /dev/null +++ b/scripts/README.txt @@ -0,0 +1,30 @@ +This folder contains a set of example scripts that be used to extend the +capabilities of the ComicTagger app. They can be run either directly through +the python interpreter, or via the ComicTagger app. + +To run via python directly, install ComicTagger source on your system using +the setup.py file. + +To run via the ComicTagger app, invoke: + +# ComicTagger -S script.py [script args] + +(This will work also for binary distributions on Mac and Windows. No need for +an extra python install.) + +The script must have an entry point function called "main()" to be invoked +via the app. + +----------------------------------------------------------------------------- + +This feature is UNSUPPORTED, and is for the convienience of developement-minded +users of ComicTagger. The comictaggerlib module will remain largely +undocumented, and it will up to the crafty script developer to look through +the code to discern APIs and such. + +That said, there are questions, please post on the forums, and hopefully we +can get your add-on scripts working! + +http://comictagger.forumotion.com/ + +