From 3c8868800e873bc4fc04bc205b80dab6f2b052a6 Mon Sep 17 00:00:00 2001 From: floriangroetschla <55492890+floriangroetschla@users.noreply.github.com> Date: Mon, 22 Nov 2021 15:27:06 +0100 Subject: [PATCH] Update README.md --- docs/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 11ce9970..9721e74b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,13 @@ # fdreadoutlibs - Far Detector readout libraries -Collection of Far Detector FrontEnd specific readout specializations. +Collection of Far Detector FrontEnd specific readout specializations. This includes type definitions to be used with the implementations in `readoutlibs` and frontend specific specializations (i.e. frame processors or software hit finding). It is the glue between `readoutlibs` and `readoutmodules` that specifies types and implementations for the use of `readoutlibs` that can then be imported by `readoutmodules` to be initialized in the `DataLinkHandler` module. ## Building and setting up the workarea -How to clone and build DUNE DAQ packages, including `readout`, is covered in [the daq-buildtools instructions](https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-buildtools/). You should follow these steps to set up your workarea that you can then use to run the following examples. +How to clone and build DUNE DAQ packages, including `readout`, is covered in [the daq-buildtools instructions](https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-buildtools/). For examples on how to run the standalone readout app, take a look at the `readoutmodules` documentation. +## Frontends and features provided by `fdreadoutlibs` +The following frontends and features are provided by this package: +* *Daphne*: Frame processor and request handler to be used with the SkipList latency buffer. +* *SSP*: Only frame processor +* *WIB*: Frame processor for `WIB`, software and hardware `WIB` TPs. Implementation of avx based software hit finding (software tpg) for `WIB` +* *WIB2*: Only frame processor