SKA-592: update naming convention (#29)

.github/actions/build-cmake-preset/action.yml

@@ -1,5 +1,5 @@
 name: build CMake preset
-description: Build the given SIL Kit Adapters CMake preset
+description: Build the given SIL Kit Adapter CMake preset
 
 inputs:
   preset-name:

.github/workflows/build-linux-release.yaml

@@ -26,4 +26,4 @@ jobs:
           prerelease: true
           draft: true
           files: |
-            _build/linux-release/SilKit-Adapters*.zip
+            _build/linux-release/SilKit-Adapter*.zip

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.5)
-project(VectorSilKitAdaptersGenericLinuxIO)
+project(VectorSilKitAdapterGenericLinuxIO)
 include(FetchContent)
 
 set(CMAKE_BUILD_RPATH_USE_ORIGIN ON)
@@ -8,8 +8,8 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 set(CMAKE_CXX_STANDARD 17)
 
-set(SILKIT_ADAPTERS_GENERIC_LINUX_IO_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/bin")
-set(SILKIT_ADAPTERS_GENERIC_LINUX_IO_LIBRARY_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/lib")
+set(SILKIT_ADAPTER_GENERIC_LINUX_IO_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/bin")
+set(SILKIT_ADAPTER_GENERIC_LINUX_IO_LIBRARY_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/lib")
 
 set(SILKIT_VERSION "4.0.50" CACHE STRING "If no SIL Kit package is specified, this version will be downloaded")
 set(SILKIT_FLAVOR "ubuntu-18.04-x86_64-gcc" CACHE STRING "If no SIL Kit package is specified, this package flavor will be downloaded")
@@ -210,7 +210,7 @@ include(GNUInstallDirs)
 
 install(
     FILES 
-        ${SILKIT_ADAPTERS_GENERIC_LINUX_IO_LIBRARY_DIRECTORY}/libSilKit.so                
+        ${SILKIT_ADAPTER_GENERIC_LINUX_IO_LIBRARY_DIRECTORY}/libSilKit.so                
     DESTINATION ${CMAKE_INSTALL_LIBDIR}
     PERMISSIONS
         OWNER_READ OWNER_WRITE
@@ -252,8 +252,8 @@ install(
 
 set(CPACK_GENERATOR "ZIP")
 
-set(CPACK_PACKAGE_DESCRIPTION "binary release of SIL Kit Adapters Generic Linux IO")
-set(CPACK_PACKAGE_NAME "SilKit-Adapters-Generic-Linux-IO")
+set(CPACK_PACKAGE_DESCRIPTION "binary release of SIL Kit Adapter Generic Linux IO")
+set(CPACK_PACKAGE_NAME "SilKit-Adapter-Generic-Linux-IO")
 set(CPACK_PACKAGE_VENDOR "Vector Informatik")
 set(CPACK_PACKAGE_CONTACT "[email protected]")
 set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}${PACKAGE_FILENAME_SUFFIX}")

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to Vector SIL Kit Adapters for Generic Linux IO
+# Contributing to Vector SIL Kit Adapter for Generic Linux IO
 
-Welcome and thank you for your interest in contributing to the Vector SIL Kit Adapters for Generic Linux IO
+Welcome and thank you for your interest in contributing to the Vector SIL Kit Adapter for Generic Linux IO
 open source project.
 
 We are sorry, but at the moment, we do not accept external contributions until

README.md

@@ -12,7 +12,7 @@ shell.
 
 **Note:** Advalues and chardev modes are supported in WSL/WSL2 if you use the Linux filesystem (not the mounted drives like `/mnt/..`). However there is no easy way to run the adapter's GPIO mode in WSL/WSL2 without recompiling the Linux kernel with the required module.
 
-## a) Getting Started with self build Adapters and Demos
+## a) Getting Started with self-built Adapter and Demos
 This section specifies steps you should do if you have just cloned the repository.
 
 To get started, please change your current directory to the top-level in the ``sil-kit-adapters-generic-linux-io``
@@ -25,10 +25,10 @@ The first thing that you should do is initializing the submodules to fetch the r
 
     git submodule update --init --recursive
 
-### Build the Adapters and Demos
+### Build the Adapter and Demos
 To build the demos, you'll need SIL Kit packages ``SilKit-x.y.z-$platform`` for your platform. You can download them directly from [Vector SIL Kit Releases](https://github.com/vectorgrp/sil-kit/releases).
 
-The adapters and demos are built using ``cmake``. If you want to build the adapter against a specific downloaded release of SIL Kit, you can follow these steps:
+The adapter and demos are built using ``cmake``. If you want to build the adapter against a specific downloaded release of SIL Kit, you can follow these steps:
 
     mkdir build
     cmake -S. -Bbuild -DSILKIT_PACKAGE_DIR=/path/to/SilKit-x.y.z-$platform/ -D CMAKE_BUILD_TYPE=Release
@@ -40,15 +40,15 @@ The adapters and demos are built using ``cmake``. If you want to build the adapt
 
 **Note 3:** If you don't provide a specific path for SILKIT_PACKAGE_DIR and there is no SIL Kit installation on your system, a SIL Kit release package (the default version listed in CMakeLists.txt) will be fetched from github.com and the adapter will be built against it.
 
-The adapters and demo executables will be available in the bin directory. Additionally the SilKit shared library is copied to the lib directory next to it automatically.
+The adapter and demo executables will be available in the bin directory. Additionally the ``SilKit`` shared library is copied to the lib directory next to it automatically.
 
-## b) Getting Started with pre-built Adapters and Demos
-Download a preview or release of the Adapters directly from [Vector SIL Kit Adapters Releases](https://github.com/vectorgrp/sil-kit-adapters-generic-linux-io/releases).
+## b) Getting Started with pre-built Adapter and Demos
+Download a preview or release of the adapter directly from [Vector SIL Kit Adapter for Generic Linux IO Releases](https://github.com/vectorgrp/sil-kit-adapters-generic-linux-io/releases).
 
 If not already existent on your system you should also download a SIL Kit Release directly from [Vector SIL Kit Releases](https://github.com/vectorgrp/sil-kit/releases). You will need this for being able to start a sil-kit-registry.
 
 ## Install the sil-kit-adapter-generic-linux-io (optional)
-If you call the following command (can be done for self build and pre build package after cmake configure) ``sil-kit-adapter-generic-linux-io`` can be called from everywhere without defining a path:  
+If you call the following command (can be done for self-built and pre-built package after cmake configure) ``sil-kit-adapter-generic-linux-io`` can be called from everywhere without defining a path:  
 
     sudo cmake --build build --target install
 
@@ -85,19 +85,19 @@ Some examples of configuration files can be found in the following demos.
 The subscribe topic is used by the adapter to receive data from the other participants.
 
 ## Analog-Digital values Demo
-The aim of this demo is to showcase the adapter forwarding bytes with an attached data type from and to a set of files through Vector SIL Kit. This demo illustrates how an analog-digital-converted values can be covered by the adapter.
+The aim of this demo is to showcase the adapter forwarding bytes with an attached data type from and to a set of files through SIL Kit. This demo illustrates how an analog-digital-converted values can be covered by the adapter.
 
 This demo is further explained in [advalues/README.md](advalues/README.md).
 
 ## Chardev Demo
 The aim of this demo is to showcase the adapter forwarding bytes from and to a set of character devices through
-Vector SIL Kit. In this demo the character devices used are FIFOs.
+SIL Kit. In this demo the character devices used are FIFOs.
 
 This demo is further explained in [chardev/README.md](chardev/README.md).
 
 ## GPIO Demo
 The aim of this demo is to showcase the adapter forwarding data from and to a GPIO chip through
-Vector SIL Kit. 
+SIL Kit. 
 
 This demo is further explained in [gpio/README.md](gpio/README.md).
 

adapter/CMakeLists.txt

@@ -37,7 +37,7 @@ set_target_properties(sil-kit-adapter-generic-linux-io
     #ensure SilKit shared libraries can be loaded
     INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN"
     BUILD_RPATH "$ORIGIN"
-    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTERS_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
+    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTER_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
 )
 
 target_compile_options(sil-kit-adapter-generic-linux-io
@@ -48,5 +48,5 @@ add_custom_command(
     TARGET sil-kit-adapter-generic-linux-io
     POST_BUILD
     COMMAND ${CMAKE_COMMAND}
-    ARGS -E copy $<TARGET_FILE:SilKit::SilKit> ${SILKIT_ADAPTERS_GENERIC_LINUX_IO_LIBRARY_DIRECTORY}/libSilKit.so
+    ARGS -E copy $<TARGET_FILE:SilKit::SilKit> ${SILKIT_ADAPTER_GENERIC_LINUX_IO_LIBRARY_DIRECTORY}/libSilKit.so
 )

adapter/README.md

@@ -32,7 +32,7 @@ In the following diagram you can see the whole setup. It illustrates the data fl
 ### Configure the Linux IO paths
 In order to match the above setup, you need to adapt Linux IO ``path`` attributes in the adapter configuration file ``./adapter/demos/DevicesConfig.yaml``. 
 
-# Running the Demos
+# Running the Demo
 Now is a good point to start the ``sil-kit-registry`` and the ``sil-kit-adapter-generic-linux-io``. In separate terminals:
 ```
 /path/to/SilKit-x.y.z-$platform/SilKit/bin/sil-kit-registry --listen-uri 'silkit://0.0.0.0:8501'

advalues/README.md

@@ -44,7 +44,7 @@ Each file can also be configured to deal with a specific data type. The handled
 - Integer values: ``uint8_t``/``int8_t`` to ``uint64_t``/``int64_t``
 - Floating-point values: ``float``, ``double``
 
-# Running the Demos
+# Running the Demo
 Now is a good point to start the ``sil-kit-registry`` and the ``sil-kit-adapter-generic-linux-io``. In separate terminals:
 ```
 /path/to/SilKit-x.y.z-$platform/SilKit/bin/sil-kit-registry --listen-uri 'silkit://0.0.0.0:8501'

advalues/demos/SimpleForward/CMakeLists.txt

@@ -19,5 +19,5 @@ set_target_properties(sil-kit-demo-glio-advalues-forward-device
     #ensure SilKit shared libraries can be loaded
     INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN"
     BUILD_RPATH "$ORIGIN"
-    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTERS_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
+    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTER_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
 )

chardev/README.md

@@ -31,7 +31,7 @@ This script will create fifo1 and fifo2 into a main folder ``chardevs``.
 ### Configure the chardev paths
 In order to match the above setup, you need to adapt the chardev ``path`` attributes in the adapter configuration file ``./chardev/demos/DevicesConfig.yaml``. 
 
-# Running the Demos
+# Running the Demo
 Now is a good point to start the ``sil-kit-registry`` and the ``sil-kit-adapter-generic-linux-io``. In separate terminals:
 ```
 /path/to/SilKit-x.y.z-$platform/SilKit/bin/sil-kit-registry --listen-uri 'silkit://0.0.0.0:8501'

chardev/demos/SimpleForward/CMakeLists.txt

@@ -20,5 +20,5 @@ set_target_properties(sil-kit-demo-glio-chardev-forward-device
     #ensure SilKit shared libraries can be loaded
     INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN"
     BUILD_RPATH "$ORIGIN"
-    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTERS_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
+    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTER_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
 )

gpio/README.md

@@ -49,7 +49,7 @@ sudo chown <new_owner> /dev/gpiochip*
 ### Configure the GPIO chip paths
 By default the GPIO chips are located under ``/dev/gpiochipX`` (with X a number). If yours are located somewhere else you should adapt the ``path`` attributes in the adapter configuration file ``./gpio/demos/DevicesConfig.yaml`` in order to match your setup.
 
-# Running the Demos
+# Running the Demo
 Now is a good point to start the ``sil-kit-registry`` and the ``sil-kit-adapter-generic-linux-io``. In separate terminals:
 ```
 /path/to/SilKit-x.y.z-$platform/SilKit/bin/sil-kit-registry --listen-uri 'silkit://0.0.0.0:8501'
@@ -129,7 +129,7 @@ cat /sys/devices/platform/gpio-sim.0/gpiochip1/sim_gpio2/value
 1
 ```
 
-The terminal output of the ForwardDevice and the SIL Kit Adapters GLIO will show that new value as well.
+The terminal output of the ForwardDevice and the GLIO Adapter will show that new value as well.
 
 ## Adding CANoe (17 SP3 or newer) as a participant
 Before you can connect CANoe to the SIL Kit network you should adapt the ``RegistryUri`` in ``./gpio/demos/SilKitConfig_CANoe.silkit.yaml`` to the IP address of your system where your sil-kit-registry is running.

gpio/demos/SimpleForward/CMakeLists.txt

@@ -20,5 +20,5 @@ set_target_properties(sil-kit-demo-glio-gpio-forward-device
     #ensure SilKit shared libraries can be loaded
     INSTALL_RPATH "$ORIGIN/../lib:$ORIGIN"
     BUILD_RPATH "$ORIGIN"
-    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTERS_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
+    RUNTIME_OUTPUT_DIRECTORY $<$<BOOL:ALWAYS>:${SILKIT_ADAPTER_GENERIC_LINUX_IO_OUTPUT_DIRECTORY}>
 )

third_party/LICENSES.rst

@@ -1,7 +1,7 @@
-SIL Kit Adapters Generic Linux IO Third Party Libraries
+SIL Kit Adapter Generic Linux IO Third Party Libraries
 ======================================
 
-The SIL Kit Adapters Generic Linux IO uses the following third party software components which are governed by their respective licenses:
+The SIL Kit Adapter Generic Linux IO uses the following third party software components which are governed by their respective licenses:
 
  1. Yaml-cpp
  2. Asio C++ Library