From 6a95bc138fc4aeadb54eca37655021fb6725fdba Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Tue, 23 Jan 2024 15:08:50 +0100
Subject: [PATCH] DOC: Better server-side scripting documentation.

Part of #22
---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index b12924b..8ba5ca8 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,17 @@ CaosDB project.
   be found elsewhere):
   - The CaosDB server must have debugging enabled.
   - The database should be empty.
+  - There should be a symlink named `debug-scripting-bin` inside the `custom` profile directory,
+    which points to the `resources` directory here in the pyinttest repository.  You can create a
+    symlink like that with the following command (adapt paths to match your setting):  
+    `custom$ ln -s ../../../../caosdb-pyinttest/resources debug-scripting-bin`
 - Modify `pycaosdb.ini.template` and save it as `pycaosdb.ini`, taking care of the following points:
   - Certificates must be valid and be specified in `pycaosdb.ini`.
   - Server-side scripting paths must be given, otherwise server-side scripting will be omitted.
+    - The local path `test_server_side_scripting.bin_dir.local` should point to a
+      `linkahead-server/scripting/bin` somwhere.
+    - The remote path `test_server_side_scripting.bin_dir.server` should probably be something like
+      `/opt/caosdb/git/caosdb-server/scripting/bin-debug`.
   - Paths for the file tests must exist, or be creatable by the testing script and the server.
 - Run the tests with `pytest` or `pytest-3` (depending on your system).
 - If you want to run just a single test, you can also select a single test file:  
-- 
GitLab