Skip to content

Commit

Permalink
docs: mrf-firmware and Readthedocs references added.
Browse files Browse the repository at this point in the history
  • Loading branch information
jerzyjamroz committed Aug 26, 2024
1 parent 56e1c19 commit 55581e4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 26 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,15 @@

---

What is Available?
------------------
# What is Available?

* More infomation on the Micro Research hardware can be found on their website http://www.mrf.fi/.
* Documentation at [https://epics-modules.github.io/mrfioc2](https://epics-modules.github.io/mrfioc2).
* [FPGA binaries and documentation](https://github.com/jpietari/mrf-firmware.git).
* [Micro-Research Finland Event System Reference documentation](https://mrftiming.readthedocs.io/en/latest/index.html).

* Documentation at [https://epics-modules.github.io/mrfioc2](https://epics-modules.github.io/mrfioc2)
# Prerequisites

Prerequisites
-------------

The required software is EPICS Base >= 3.14.10, devLib2 >= 2.8, and the MSI tool (included in Base >= 3.15.1).

Base: [http://www.aps.anl.gov/epics/base/R3-15/index.php](http://www.aps.anl.gov/epics/base/R3-15/index.php)

devLib2: [https://github.com/epics-modules/devlib2/](https://github.com/epics-modules/devlib2/)

MSI: [http://www.aps.anl.gov/epics/extensions/msi/index.php](http://www.aps.anl.gov/epics/extensions/msi/index.php)
The required software is:
* [epics-base](https://github.com/epics-base/epics-base) >= 3.15.1,
* [devLib2](https://github.com/epics-modules/devlib2) >= 2.8.
20 changes: 7 additions & 13 deletions documentation/mainpage.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,9 @@ The canonical version of this page is @url http://epics-modules.github.io/mrfioc
@subsection requires Requires
EPICS Base >= 3.14.10
@url http://www.aps.anl.gov/epics/
MSI (Macro expansion tool) Required with Base < 3.15.1
@url http://www.aps.anl.gov/epics/extensions/msi/index.php
devLib2 >= 2.9
@url https://epics-modules.github.io/devlib2/
RTEMS >= 4.9.x, vxWorks >=6.7, or Linux >= 2.6.26.
- epics-base @url https://github.com/epics-base/epics-base >= 3.15.1,
- devLib2 @url https://github.com/epics-modules/devlib2 >= 2.8.
- RTEMS >= 4.9.x, vxWorks >=6.7, or Linux >= 2.6.26.
@section hardware Supported Hardware
Expand Down Expand Up @@ -70,6 +60,10 @@ User documentation can be found in the form of usage manuals for both the
and
<a href="evg-usage.pdf">Generator</a>
The FPGA binaries and documentation releases are provided within the <a href="https://github.com/jpietari/mrf-firmware.git">mrf-firmware</a> repository.
The <a href="https://mrftiming.readthedocs.io/en/latest/index.html">Micro-Research Finland Event System Reference documentation</a> is available on Readthedocs for community contributions.
Those interested in the implementation for the Receiver might wish to start with mrmEvrSetupPCI()
and mrmEvrSetupVME() or the ::EVRMRM class.
Expand Down

0 comments on commit 55581e4

Please sign in to comment.