From 69803441a6a51925e80483d672c8aa4fec0643b5 Mon Sep 17 00:00:00 2001
From: Marcus Green <marcusavgreen@gmail.com>
Date: Sun, 26 May 2024 17:51:32 +0100
Subject: [PATCH] Update README.md

---
 README.md | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 6d14ddd..19331b7 100644
--- a/README.md
+++ b/README.md
@@ -11,12 +11,19 @@ https://github.com/marcusgreen/moodle-tool_aiconnect
 Additional documentation can be found here https://github.com/marcusgreen/moodle-qtype_aitext/wiki
 
 ## Prompting
-It is currently limited to the immediate feedback quesiton behaviour. It requires the creation of a prompt to evaluate the text according to its purpose. For example to confirm the grammar in English the following can be used.
+It requires the creation of a prompt to evaluate the text according to its purpose and an optional marking scheme. For example for a question 
 
-"Explain if there is anything wrong with the Grammar in this sentence.  Give 10 marks if there are no errors and all spelling is correct and it is in the past tense. Give 0 marks if the grammar is incorrect. Deduct one mark,  every word where the spelling is incorrect. Reply in json format with a response and marks fields."
+"Write an English sentence in the past tense"
 
-It may help to test prompts directly on the Chat GPT site to confirm they  work as expected.
+The prompt could be
 
+"Explain if there is anything wrong with the Grammar in this text."
+
+An example mark scheme could be
+
+Give 10 marks if there are no errors and all spelling is correct and it is in the past tense. Give 0 marks if the grammar is incorrect. Deduct one mark,  every word where the spelling is incorrect"
+
+There is a prompttester field in the quesition editing form which uses ajax to test out prompts without needing to go through the quesiton preview screen.
 
 ## Limitations
 
@@ -28,7 +35,6 @@ Mobile app compatibility
 
 Cron based evaluation. Allow for slow LLM systems by marking on a cron timer
 
-
 ## Promotion
 If you are a Moodle developer and you use vscode/vscodium you should consider this plugin https://marketplace.visualstudio.com/items?itemName=LMSCloud.mdlcode.
 It it very reasonably priced and will quickly save you time and frustration. It is the best Moodle development tool I have come accross in 20 years.