updated readme in order to document how current version can be run. C…

…urrently, the user has to manually generate prompts, whereas we will commit the ones that have been used

README.md

@@ -4,6 +4,18 @@ Multilingual Analysis of LLMs for Clinical Observations
 
 Built using the PhEval runner template (see instructions below).
 
+# Usage
+Let us start by documenting how to run the current version in a new folder. This has to be changed!
+```shell
+poetry install
+poetry shell
+mkdir myinputdirectory
+mkdir myoutputdirectory
+cp -r /path/to/promptdir myinputdirectory/
+cp inputdir/config.yaml myinputdirectory
+pheval run -i myinputdirectory -r "malcorunner" -o myoutputdirectory -t tests
+```
+
 ## Template Runner for PhEval
 
 This serves as a template repository designed for crafting a personalised PhEval runner. Presently, the runner executes a mock predictor found in `src/pheval_template/run/fake_predictor.py`. Nevertheless, the primary objective is to leverage this repository as a starting point to develop your own runner for your tool, allowing you to customise and override existing methods effortlessly, given that it already encompasses all the necessary setup for integration with PhEval. There are exemplary methods throughout the runner to provide an idea on how things could be implemented.