Skip to content

Commit 96a729f

Browse files
authored
branding: drop Vector prefix from SIL Kit (#290)
Remove the "Vector" branding from the documentation. Add the Synopsys product site next to the Vector product site badge in the top-level readme --------- Signed-off-by: Marius Börschig <Marius.Boerschig@vector.com>
1 parent 9503341 commit 96a729f

File tree

26 files changed

+60
-57
lines changed

26 files changed

+60
-57
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# Contributing to Vector SIL Kit
1+
# Contributing to the SIL Kit Project
22

3-
Welcome and thank you for your interest in contributing to the Vector SIL Kit
3+
Welcome and thank you for your interest in contributing to the SIL Kit
44
open source project.
5+
Since January 2026, SIL Kit is engineered and maintained by Vector and Synopsys in collaboration.
56

6-
We are sorry, but at the moment, we do not accept external contributions until
7-
we have established a contribution process. We're working behind the scenes to
8-
get this ready in the future. Until then, we would kindly ask you to not open pull
9-
requests.
7+
We are sorry, but at the moment, we do not accept external contributions until we have established a contribution process.
8+
However, you can contribute to the open-source project by creating an issue to discuss bugs or feature requests in public.
9+
10+
We're working behind the scenes to get this ready in the future.
11+
Until then, we would kindly ask you to not open pull requests.
1012

1113
We will update this document when we are ready for your submissions.
1214
Thank you and stay tuned!

README.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
================================
2-
The Vector SIL Kit
2+
The SIL Kit Project
33
================================
4-
.. |VectorSite| image:: https://img.shields.io/badge/vector-sil--kit-red
4+
.. |VectorSite| image:: https://img.shields.io/badge/vector-product%20site-red.svg
55
:target: https://vector.com/sil-kit
6+
.. |SynopsysSite| image:: https://img.shields.io/badge/synopsys-product%20site-purple.svg
7+
:target: https://www.synopsys.com/verification/virtual-prototyping/sil-kit.html
68

79
.. |ReleaseBadge| image:: https://img.shields.io/github/v/release/vectorgrp/sil-kit.svg
810
:target: https://github.com/vectorgrp/sil-kit/releases
@@ -21,16 +23,16 @@ The Vector SIL Kit
2123
:target: https://github.com/vectorgrp/sil-kit/actions/workflows/build-win.yml
2224
.. |Linux/Arm64| image:: https://github.com/vectorgrp/sil-kit/actions/workflows/build-linux-arm64.yml/badge.svg
2325
:target: https://github.com/vectorgrp/sil-kit/actions/workflows/build-linux-arm64.yml
24-
| |VectorSite|
2526
| |ReleaseBadge| |LicenseBadge| |DocsBadge|
2627
| |AsanBadge| |UbsanBadge| |TsanBadge| |Linux/Arm64|
2728
| |WinBadge|
29+
| |VectorSite| |SynopsysSite|
2830
29-
The Vector SIL Kit is an open-source library for connecting Software-in-the-Loop Environments.
30-
This README is intended to provide you with quick start on how to build the Vector SIL Kit.
31+
The SIL Kit is an open-source library for connecting Software-in-the-Loop Environments.
32+
This README is intended to provide you with quick start on how to build the SIL Kit.
3133

32-
For documentation on using the Vector SIL Kit, see the HTML documentation,
33-
which can be generated when building the Vector SIL Kit (cf. Customizing the
34+
For documentation on using the SIL Kit, see the HTML documentation,
35+
which can be generated when building the SIL Kit (cf. Customizing the
3436
Build) and is provided in pre-built form with the SIL Kit packages.
3537

3638
The SIL Kit source and documentation is licensed under a permissible open
@@ -54,7 +56,7 @@ The SIL Kit ecosystem comprises the following turn-key solutions:
5456
project provides first-class support for TAP devices of the host operating system.
5557

5658
* The `SIL Kit Adapter for virtual CAN <https://github.com/vectorgrp/sil-kit-adapters-vcan>`_
57-
can be used to attach a virtual CAN interface (SocketCAN) to a Vector SIL Kit CAN bus.
59+
can be used to attach a virtual CAN interface (SocketCAN) to a SIL Kit CAN bus.
5860

5961
* The `SIL Kit Adapter for Generic Linux IO <https://github.com/vectorgrp/sil-kit-adapters-generic-linux-io>`_
6062
allows to attach SIL Kit to a generic Linux IO device, such as character devices or GPIOs.
@@ -99,7 +101,7 @@ directory and configure CMake::
99101
cmake ..
100102

101103

102-
3. Build the Vector SIL Kit
104+
3. Build the SIL Kit
103105
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104106

105107
Once the project has been generated, you can build the SIL Kit using the

SilKit/source/SilKit.rc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#define VERSIONSTRING(a,b,c,d) STRING_HELPER(a) "." STRING_HELPER(b) "." STRING_HELPER(c) "." STRING_HELPER(d)
77

88
#define ASSEMBLYINFO_COMPANY "Vector Informatik GmbH"
9-
#define ASSEMBLYINFO_PRODUCT "Vector SIL Kit"
9+
#define ASSEMBLYINFO_PRODUCT "SIL Kit"
1010
#define ASSEMBLYINFO_COPYRIGHT "Copyright © 2022 Vector Informatik GmbH."
1111
#define ASSEMBLYINFO_FILEDESCRIPTION "Vector SIL Kit by Vector Informatik GmbH"
1212
#define ASSEMBLYINFO_VERSIONSTRING VERSIONSTRING(SILKIT_VERSION_MAJOR,SILKIT_VERSION_MINOR,SILKIT_VERSION_PATCH,SILKIT_BUILD_NUMBER)
@@ -38,7 +38,7 @@ BEGIN
3838
VALUE "CompanyName", ASSEMBLYINFO_COMPANY
3939
VALUE "FileDescription", ASSEMBLYINFO_FILEDESCRIPTION
4040
VALUE "FileVersion", ASSEMBLYINFO_VERSIONSTRING
41-
VALUE "InternalName", "Vector SIL Kit"
41+
VALUE "InternalName", "SIL Kit"
4242
VALUE "LegalCopyright", ASSEMBLYINFO_COPYRIGHT
4343
VALUE "OriginalFilename", "SilKit.dll"
4444
VALUE "ProductName", ASSEMBLYINFO_PRODUCT

Utilities/SilKitMonitor/PassiveSystemMonitor.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ int main(int argc, char** argv)
8282
commandlineParser.Add<CliParser::Flag>("sync", "s", "[--sync]",
8383
"-s, --sync: Run with virtual time synchronization.");
8484

85-
std::cout << "Vector SIL Kit -- System Monitor, SIL Kit version: " << SilKit::Version::String() << std::endl
85+
std::cout << "SIL Kit -- System Monitor, SIL Kit version: " << SilKit::Version::String() << std::endl
8686
<< std::endl;
8787

8888
try
@@ -116,7 +116,7 @@ int main(int argc, char** argv)
116116
std::string hash{SilKit::Version::GitHash()};
117117
auto shortHash = hash.substr(0, 7);
118118
std::cout << "Version Info:" << std::endl
119-
<< " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
119+
<< " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
120120

121121
return 0;
122122
}

Utilities/SilKitRegistry/Registry.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ int main(int argc, char** argv)
351351
"-W, --windows-service: Run as a Windows service.", CliParser::Hidden);
352352
}
353353

354-
std::cout << "Vector SIL Kit -- Registry, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl;
354+
std::cout << "SIL Kit -- Registry, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl;
355355

356356
try
357357
{
@@ -403,7 +403,7 @@ int main(int argc, char** argv)
403403
std::string hash{SilKit::Version::GitHash()};
404404
auto shortHash = hash.substr(0, 7);
405405
std::cout << "Version Info:" << std::endl
406-
<< " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
406+
<< " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
407407

408408
return 0;
409409
}

Utilities/SilKitSystemController/SystemController.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ int main(int argc, char** argv)
311311
"--non-interactive: Run without awaiting any user interactions at any time.",
312312
CliParser::Hidden);
313313

314-
std::cout << "Vector SIL Kit -- System Controller, SIL Kit version: " << SilKit::Version::String() << std::endl
314+
std::cout << "SIL Kit -- System Controller, SIL Kit version: " << SilKit::Version::String() << std::endl
315315
<< std::endl;
316316

317317
try
@@ -345,7 +345,7 @@ int main(int argc, char** argv)
345345
std::string hash{SilKit::Version::GitHash()};
346346
auto shortHash = hash.substr(0, 7);
347347
std::cout << "Version Info:" << std::endl
348-
<< " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
348+
<< " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
349349

350350
return 0;
351351
}

cmake/README.txt.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
Vector SIL Kit Release Version: @PROJECT_VERSION@
1+
SIL Kit Release Version: @PROJECT_VERSION@
22
---------------------------------------------
33

44
The layout of this release bundle is as follows:
55

66
+ SilKit/
7-
- the binary Vector SIL Kit release including the object files,
7+
- the binary SIL Kit release including the object files,
88
the C++ interface headers and CMake exported targets.
99

1010
+ SilKit-Demos/

docs/_templates/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
{% extends "!layout.html" %}
55
{% block sidebartitle %}
66
<a class="icon icon-home" href="contents.html">
7-
Vector SIL Kit
7+
SIL Kit
88
</a>
99
<div class="version" style="margin-bottom: 0.5em;">
1010
Version: {{ release }}

docs/api/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
C/C++ API
55
=========
66

7-
This document describes the user available programming interfaces of the Vector |ProductName|.
7+
This document describes the user available programming interfaces of the |ProductName|.
88
If you are not yet familiar with the |ProductName|, have a look at the :doc:`Developers Guide<../for-developers/developers>`.
99
Information on API organization in the |ProductName|:
1010

docs/changelog/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Changelog
22
=========
33

4-
All notable changes to the Vector SIL Kit project are listed on the respective
4+
All notable changes to the SIL Kit project are listed on the respective
55
versions page.
66

77
.. toctree::

0 commit comments

Comments
 (0)