Add reference to naming convention to readme (#4)

* Add reference to naming convention to readme Signed-off-by: ClemensLinnhoff <[email protected]> --------- Signed-off-by: ClemensLinnhoff <[email protected]>
openMSL · Jan 9, 2024 · 172af96 · 172af96
1 parent af31433
commit 172af96
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # SL-5-5 OSI Trace File Player
 
 This [FMU](https://fmi-standard.org/) is able to play binary OSI trace files.
+The trace file names have to comply to the [OSI trace file naming convention](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/architecture/trace_file_naming.html),
+as the player parses the name to identify the message type (SensorView or SensorData) of the trace file.
 The folder containing the trace files has to be passed as FMI parameter _trace_path_.
 The trace file player is build according to the [ASAM Open simulation Interface (OSI)](https://github.com/OpenSimulationInterface/open-simulation-interface) and the [OSI Sensor Model Packaging (OSMP)](https://github.com/OpenSimulationInterface/osi-sensor-model-packaging) examples.