From b6710eb557f75362b8ab861a34b4148d2552edcf Mon Sep 17 00:00:00 2001 From: Greg S Date: Thu, 14 May 2009 17:41:06 +0000 Subject: Add some (brief) documentation on how to use in an activity. --- diff --git a/doc/including.rst b/doc/including.rst new file mode 100644 index 0000000..f087ae5 --- /dev/null +++ b/doc/including.rst @@ -0,0 +1,15 @@ +How to Include the Question API in your Activity +================================================ + +The quizdata module, supplied by the Question Support API requires two other +libraries (currently) in order to function: + - PEAK-Rules + - PyParsing + +Both of these libraries need to be available for the quizdata module to be +imported. Follow the standard method for including libraries in your activity +to include those libraries, as well as the quizdata module, as a library. In +the question-support-api project repository the only needed part to include in +your activity is the quizdata directory, which should be placed on the python +search path (preferably with other libraries required by your activity, rather +than in the activity's own source area). -- cgit v0.9.1