From b55849594302670418eed64a143d83cfd605933a Mon Sep 17 00:00:00 2001 From: Leonhard Reichenbach Date: Tue, 25 Jun 2024 10:59:11 +0200 Subject: [PATCH] update README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e80f93f..eacbddd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ # CLDConfig + This package contains configuration files for the CLD detector model, it is based on the configuration files from the [CLICPerformance](https://github.com/iLCSoft/CLICPerformance) package transferred to this package with their full history. The new configuration files are in [CLDConfig](CLDConfig). The [fcceeConfig](fcceeConfig) directory contains the archived (Marlin only) configuration files used for previous studies. + +## Usage + +Usage information can be found at https://fcc-ee-detector-full-sim.docs.cern.ch/CLD + +## Common issues + +CLDConfig follows the Key4hep nightlies. +For usage with the latest stable release please `git checkout` the respective tag yourself. + +A list of known issues can be found here: https://github.com/key4hep/CLDConfig/issues/35