Fix vss version to 3.0 in readme (eclipse-velocitas#40)

* Fix vss version to 3.0 in readme
SoftwareDefinedVehicle · Jul 25, 2023 · 1cc304b · 1cc304b
1 parent 7907fea
commit 1cc304b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 9 deletions.
diff --git a/NOTICE-3RD-PARTY-CONTENT.md b/NOTICE-3RD-PARTY-CONTENT.md
@@ -4,16 +4,16 @@
 | Dependency | Version | License |
 |:-----------|:-------:|--------:|
 |bandit|1.7.5|Apache 2.0|
-|black|23.3.0|MIT|
+|black|23.7.0|MIT|
 |cfgv|3.3.1|MIT|
-|click|8.1.3|New BSD|
-|distlib|0.3.6|Python Software Foundation License|
+|click|8.1.6|New BSD|
+|distlib|0.3.7|Python Software Foundation License|
 |exceptiongroup|1.1.2|MIT|
 |filelock|3.12.2|The Unlicense (Unlicense)|
 |flake8|6.0.0|MIT|
 |gitdb|4.0.10|BSD|
-|GitPython|3.1.31|BSD|
-|identify|2.5.24|MIT|
+|GitPython|3.1.32|BSD|
+|identify|2.5.26|MIT|
 |iniconfig|2.0.0|MIT|
 |isort|5.12.0|MIT|
 |markdown-it-py|3.0.0|MIT|
@@ -25,23 +25,23 @@
 |packaging|23.1|Apache 2.0<br/>BSD|
 |pathspec|0.11.1|Mozilla Public License 2.0 (MPL 2.0)|
 |pbr|5.11.1|Apache 2.0|
-|platformdirs|3.8.0|MIT|
+|platformdirs|3.9.1|MIT|
 |pluggy|1.2.0|MIT|
 |pre-commit|3.3.3|MIT|
 |pycodestyle|2.10.0|MIT|
 |pydocstyle|6.3.0|MIT|
 |pyflakes|3.0.1|MIT|
 |Pygments|2.15.1|Simplified BSD|
 |pytest|7.4.0|MIT|
-|PyYAML|6.0|MIT|
+|PyYAML|6.0.1|MIT|
 |rich|13.4.2|MIT|
 |setuptools|58.1.0|MIT|
 |smmap|5.0.0|BSD|
 |snowballstemmer|2.2.0|New BSD|
 |stevedore|5.1.0|Apache 2.0|
 |tomli|2.0.1|MIT|
 |typing-extensions|4.7.1|Python Software Foundation License|
-|virtualenv|20.23.1|MIT|
+|virtualenv|20.24.2|MIT|
 ## Workflows
 | Dependency | Version | License |
 |:-----------|:-------:|--------:|

diff --git a/README.md b/README.md
@@ -21,9 +21,11 @@ python3 gen_vehicle_model.py <path_to_your_json_file>
 ```
 ### Example
 ```bash
-git clone https://github.com/COVESA/vehicle_signal_specification.git
+git clone -b v3.1 https://github.com/COVESA/vehicle_signal_specification.git
 python3 gen_vehicle_model.py -I ./vehicle_signal_specification/spec ./vehicle_signal_specification/spec/VehicleSignalSpecification.vspec
 ```
+> **Note**<br>
+> Vehicle-model-generator only supports vss versions up to v3.1, newest versions will be supported soon.
 
 Or use VSCode Launch: Press ```F5```, select ```Python``` or ```cpp```.