From 27744983b5bf501d46b9695bdc6fe0fc1076c10b Mon Sep 17 00:00:00 2001
From: Eva Lott <evalott100@gmail.com>
Date: Fri, 1 Mar 2024 10:51:33 +0000
Subject: [PATCH] converted README to md

---
 README.md | 34 ++++++++++++++++++----------------
 1 file changed, 18 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 991e1b3e..35027a70 100644
--- a/README.md
+++ b/README.md
@@ -3,12 +3,9 @@
 [![PyPI](https://img.shields.io/pypi/v/pandablocks-ioc.svg)](https://pypi.org/project/pandablocks-ioc)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-# pandablocks_ioc
+# PandABlocks-ioc
 
-Create an IOC from a PandA
-
-This is where you should write a short paragraph that describes what your module does,
-how it does it, and why people should use it.
+A softioc to control a [PandABlocks-FPGA](https://github.com/PandABlocks/PandABlocks-FPGA).
 
 Source          | <https://github.com/PandABlocks/PandABlocks-ioc>
 :---:           | :---:
@@ -17,22 +14,27 @@ Docker          | `docker run ghcr.io/pandablocks/PandABlocks-ioc:latest`
 Documentation   | <https://pandablocks.github.io/PandABlocks-ioc>
 Releases        | <https://github.com/PandABlocks/PandABlocks-ioc/releases>
 
-This is where you should put some images or code snippets that illustrate
-some relevant examples. If it is a library then you might put some
-introductory code here:
-
-```python
-from pandablocks_ioc import __version__
+To run the ioc:
 
-print(f"Hello pandablocks_ioc {__version__}")
+```text
+$ python -m pandablocks-ioc softioc <pandabox host> <pv prefix> --screens-dir=<directory to output bobfiles> --clear-bobfiles
 ```
 
-Or if it is a commandline tool then you might put some example commands here:
+PVs will be available for all the values shown on the [web client](https://github.com/PandABlocks/PandABlocks-webcontrol):
 
+```text
+$ caget PANDA:CALC1:INPA
+PANDA:CALC1:INPA               ZERO
 ```
-python -m pandablocks_ioc --version
-```
+
+<img src="https://raw.githubusercontent.com/PandABlocks/PandABlocks-ioc/main/docs/images/webui_calc1.png" width="300px">
+
+On start-up the ioc will use [PVI](https://github.com/epics-containers/pvi) to generate bobfiles for viewing the PVs in phoebus:
+
+<img src="https://raw.githubusercontent.com/PandABlocks/PandABlocks-ioc/main/docs/images/phoebus_calc1.png" width="34%">
+
+<img src="https://raw.githubusercontent.com/PandABlocks/PandABlocks-ioc/main/docs/images/screen_index.png" width="64%">
 
 <!-- README only content. Anything below this line won't be included in index.md -->
 
-See https://pandablocks.github.io/PandABlocks-ioc for more detailed documentation.
+See <https://PandABlocks.github.io/PandABlocks-ioc> for more detailed documentation.