Update README.md

2024-11-19 11:58:58 +01:00
parent 5c1b901829
commit 76e47011e8
1 changed files with 20 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,21 @@
 # dynaPV
+
+## What?
+
+A "regular" soft-IOC within the PSI framework that allows to dynamically create new PVs. It comes with a caQtDM panel, which looks like this:
+
+![screenshot](https://gitlab.psi.ch/augustin_s/dynapv/-/wikis/uploads/c5f83796d7f54a686d263778ced2fa1b/dynaPV.png)
+
+Description of fields and buttons:
+
+- `Name`: name of the PV to be created or removed.
+- `Type`: type of the PV to be created (may be `float`, `int`, `bool` or `str`).
+- `add`: add the PV as configured, overwrites if type has changed.
+- `remove`: remove the PV, checks the name but not the type.
+- `apply` restart the IOC to apply changes.
+
+## Installation?
+
+```bash
+ioc install -V
+```