Skip to content

Update readme setup section #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomkane-dls merged 4 commits into from
Jan 16, 2026
Merged

Update readme setup section #191

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e957b1
Updated README setup section with techui.yaml -url and techui-support…
tomkane-dls Jan 12, 2026
1170b24
changed underscore to hyphen for techui-support
tomkane-dls Jan 12, 2026
4e3e974
Removed manual techui-support setup, added instructions to clone ixx-…
tomkane-dls Jan 14, 2026
6971495
Merge branch 'main' into update-readme-setup
tomkane-dls Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,17 @@ The process to use this module goes as follows (WIP):
## Setting Up

1. Clone the beamline `ixx-services` repo to the root of this project, ensuring each IOC service has been converted to the [ibek](git@github.com:epics-containers/ibek.git) format.
1. Create your handmade synoptic overview screen in Phoebus and place inside `ixx-services/synoptic/index.bob`.

`git clone --recursive git@gitlab.diamond.ac.uk:controls/containers/beamline/ixx-services.git`
1. Create your handmade synoptic overview screen in Phoebus and place at `ixx-services/synoptic/index.bob`.
1. Construct a `techui.yaml` file inside `ixx-services/synoptic` containing all the components from the services:

```
beamline:
short_dom: {e.g. b23, b01-1}
long_dom: {e.g. bl23b}
desc: {beamline description}
url: {e.g. b23-opis.diamond.ac.uk}

components:
{component name}:
Expand Down