Repository README Files: Modify

[JackEAllen]

As a: developer

I would like to add links to the relevant WIKI information to some repos and add links on some WIKI pages back to those repos to allow me to easily find relevant information I may need to tackle a given issue.

Acceptance Criteria

What is the acceptance criteria?

• URLs added to a repositories README.md to relevant recourses where applicable:
  • WIKI Pages
  • Relevant file locations such as manuals
  • Locations of other relevant repositories.
• URLS on WIKI pages linked too in repositories back to the relevant repositories.

Extra Information

Why it is needed?
This issue was created in response to discussions which took place in the retrospective meeting which notes can be found for in the WIKI HERE.

Where required files/links are
Repositories modified in response to retrospective:
add here as modified
PEARL Pressure Controller

• Create minimum repository documentation EPICS_PearlPressure#2
• Create README.md with minimum documentation EPICS-ioc#656
• README Update EPICS-motionSetPoints#24
• README Update EPICS-jaws#16
• Triton README Update EPICS-Triton#4
• CRISP Spin Flipper README Update EPICS-Flipprps#4

[JackEAllen]

Just adding documentation for the Pearl Pressure controller for today:

• Create minimum repository documentation EPICS_PearlPressure#2
• Create README.md with minimum documentation EPICS-ioc#656

We could keep this issue open to track where documentation has been added so far for the time being.

The next time this issue is looked at, we should aim to try adding minimum documentation to another type of repository to see if the same format used for the Pearl Pressure controller works for other repositories.

[JackEAllen]

To review, please look at the below PR's and tick checkboxes inside issue description

• Create minimum repository documentation EPICS_PearlPressure#2
• Create README.md with minimum documentation EPICS-ioc#656

[JamesKingWork]

Can we add links to the support and ioc modules at https://github.com/ISISComputingGroup/IBEX/wiki/PEARL-Instrument-Details#note-pressure-cell-controller