diff --git a/README.rst b/README.rst index cd890ad3..82942f39 100644 --- a/README.rst +++ b/README.rst @@ -3,14 +3,7 @@ PandABlocks-ioc |code_ci| |docs_ci| |coverage| |pypi_version| |license| -.. note:: - - This project contains template code only. For documentation on how to - adopt this skeleton project see - https://DiamondLightSource.github.io/python3-pip-skeleton-cli - -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 `_. ============== ============================================================== PyPI ``pip install PandABlocks-ioc`` @@ -19,19 +12,33 @@ 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: +To run the ioc: + +.. code-block:: text + + $ python -m pandablocks-ioc softioc --screens-dir= --clear-bobfiles + +| + +PVs will be available for all the values shown on the `web client `_: + +.. code-block:: text + + $ caget PANDA:CALC1:INPA + PANDA:CALC1:INPA ZERO -.. code-block:: python +.. image:: https://raw.githubusercontent.com/PandABlocks/PandABlocks-ioc/main/docs/images/webui_calc1.png + :width: 300 - from pandablocks_ioc import __version__ +| - print(f"Hello pandablocks_ioc {__version__}") +On start-up the ioc will use `PVI `_ to generate bobfiles for viewing the PVs in phoebus: -Or if it is a commandline tool then you might put some example commands here:: +.. image:: https://raw.githubusercontent.com/PandABlocks/PandABlocks-ioc/main/docs/images/phoebus_calc1.png + :width: 34% +.. image:: https://raw.githubusercontent.com/PandABlocks/PandABlocks-ioc/main/docs/images/screen_index.png + :width: 64% - $ python -m pandablocks_ioc --version .. |code_ci| image:: https://github.com/PandABlocks/PandABlocks-ioc/actions/workflows/code.yml/badge.svg?branch=main :target: https://github.com/PandABlocks/PandABlocks-ioc/actions/workflows/code.yml diff --git a/docs/images/phoebus_calc1.png b/docs/images/phoebus_calc1.png new file mode 100644 index 00000000..5060697b Binary files /dev/null and b/docs/images/phoebus_calc1.png differ diff --git a/docs/images/screen_index.png b/docs/images/screen_index.png new file mode 100644 index 00000000..979c3886 Binary files /dev/null and b/docs/images/screen_index.png differ diff --git a/docs/images/webui_calc1.png b/docs/images/webui_calc1.png new file mode 100644 index 00000000..d96cb061 Binary files /dev/null and b/docs/images/webui_calc1.png differ