-
Notifications
You must be signed in to change notification settings - Fork 157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README.md: Add badges, improve order name contributors instead of put… #291
Merged
danielwilms
merged 1 commit into
COVESA:master
from
boschglobal:feature/improve-main-readme
Jun 8, 2021
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,48 @@ | ||
**(C) 2019 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)**<br> | ||
**(C) 2018 Volvo Cars**<br> | ||
**(C) 2016 Jaguar Land Rover**<br> | ||
# VEHICLE SIGNAL SPECIFICATION | ||
|
||
All files and artifacts in this repository are licensed under the | ||
provisions of the license provided by the LICENSE file in this repository. | ||
|
||
# VEHICLE SIGNAL SPECIFICATION | ||
[![License](https://img.shields.io/badge/License-MPL%202.0-blue.svg)](https://opensource.org/licenses/MPL-2.0) | ||
[![Build Status](https://travis-ci.org/GENIVI/vehicle_signal_specification.svg?branch=master)](https://travis-ci.org/GENIVI/vehicle_signal_specification) | ||
|
||
|
||
The overall goal of the Vehicle Signal Specification (VSS) is to create a common understanding of vehicle signals in order to reach a “common language” independent of the protocol or serialisation format. | ||
|
||
Please find the official documentation at: [Vehicle Signal Specification](https://genivi.github.io/vehicle_signal_specification/) | ||
|
||
**Cloning:** | ||
## Getting started | ||
|
||
### Using VSS | ||
To use a specific version of VSS in your toolchain, head over to our [releases page](https://genivi.github.io/vehicle_signal_specification/releases/). | ||
|
||
|
||
**Latest release:** [2.1](https://github.com/GENIVI/vehicle_signal_specification/releases/tag/v2.1) | ||
|
||
|
||
### Contribute to VSS | ||
Work towards version 2.2 is continuously ongoing in the [master branch](https://github.com/GENIVI/vehicle_signal_specification/tree/master) | ||
|
||
To work with the specification directly, you need to clone this repository. | ||
|
||
This repository uses git submodules. Please make sure you clone recursively, | ||
or if you didn't, just init and update the submodules afterwards: | ||
|
||
``` | ||
git clone --recurse-submodules https://github.com/GENIVI/vehicle_signal_specification | ||
``` | ||
or | ||
|
||
|
||
Alternatively, just init and update the submodules after the initial cloning: | ||
|
||
``` | ||
git clone https://github.com/GENIVI/vehicle_signal_specification | ||
git submodule update --init | ||
``` | ||
|
||
**Latest release:** [2.1](https://github.com/GENIVI/vehicle_signal_specification/releases/tag/v2.1) | ||
|
||
Work towards version 2.2 is continuously ongoing in [master branch](https://github.com/GENIVI/vehicle_signal_specification/tree/master) | ||
## Contributors | ||
VSS is an open standard and we invite anybody to contribute. Currently VSS contains - among others - significant contributions from | ||
- [Bayerische Motoren Werke Aktiengesellschaft (BMW AG)](https://www.bmwgroup.com/) | ||
- [Volvo Cars](https://www.volvocars.com/) | ||
- [Jaguar Land Rover](https://www.jaguarlandrover.com/) | ||
- [Robert Bosch GmbH](https://www.bosch.com/) | ||
- [Geotab Inc](https://www.geotab.com/about/). | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this. Is the order intended to reflect a timeline?, i.e. if someone in the future think that deserve to be listed, then they shall add their name at the end of the list.
(From the old copyright statement JLR was the oldest contributor or should be listed first?)
The alternative is of course to have something that corresponds to alphabetical order