Skip to content
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.

Sign up for GitHub

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

root README.md: add note about git submodules #39

Merged
merged 1 commit into from
Apr 26, 2024
Merged

root README.md: add note about git submodules #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ A good place to start is the overview in the documentation which introduces why

Once you are ready to jump into some code the docker deployment readme explains building and starting the playground. Whilst the hello-world example provides simple examples of accessing the data store directly and using the data server to get/set data using the [Vehicle Information Service Specification (VISS)](https://github.com/COVESA/vehicle-information-service-specification) API. Hello-world can also be used as a sanity test that the playground is operating as expected.

### Cloning the source repository
The playground git source repository contains git submodules which need to be initialized either during the clone or afterwords as shown below.

Clone with git v2.13 and later:
```
git clone --recurse-submodules https://github.com/COVESA/cdsp.git
```

Clone with git v1.9 and later:
```
git clone --recursive https://github.com/COVESA/cdsp.git
```

If the repository is already cloned:
```
cd <path to cdsp root>
git submodule update --init --recursive
```

## Known issues
See the github issues for this project with the `bug` label.

Expand Down
Loading