🔨 Refactored README, Installation, Contributing #400
Merged
Conversation
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
sschleemilch
force-pushed
the
feature/docs-quickstart
branch
4 times, most recently
from
5e687e8
to
6b6df1c
Compare
sschleemilch
changed the title
erikbosch
reviewed
Sep 6, 2024
|
|
||
| There are several ways of installing `vss-tools`. | ||
| If you would like to contribute then please follow the [contribute](#contributing) section instead. | ||
| All of them are recommended to be done in an activated python virtual environment: |
There was a problem hiding this comment.
As we have seen some people struggling to get a working Python environment I am thinking if we should give some more guidance here, either just add a link to venv documentation like "activated python virtual environment" or possibly also show an example how to do it, like in this README
https://github.com/eclipse-kuksa/kuksa-python-sdk/blob/main/docs/building.md
There was a problem hiding this comment.
Added instructions how to create a venv
Signed-off-by: Sebastian Schleemilch <sebastian.schleemilch@bmw.de>
sschleemilch
force-pushed
the
feature/docs-quickstart
branch
from
6b6df1c
to
eaf8768
Compare
erikbosch
approved these changes
Sep 6, 2024
|
MoM:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
See rendered version: https://github.com/sschleemilch/vss-tools/tree/feature/docs-quickstart