docs: restructure readme #46
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
danielgordon-switch-ev
requested review from
tropxy,
shalinnijel2,
mdwcrft and
snorkman88
|
This looks fine to me, but probably needs a closer look from someone closer to the project @shalinnijel2 @tropxy |
Comment on lines
+72
to
+75
| poetry install | ||
|
|
||
| poetry-shell: | ||
| poetry shell |
There was a problem hiding this comment.
As this could fail if poetry is not available, would it perhaps be better if there is a 'pip install poetry' before 'poetry install'?
| The following command provides a helper for the script usage: | ||
|
|
||
| ```bash | ||
| $ cd iso15118/shared/pki/ |
There was a problem hiding this comment.
Nice...helps with copy pasting to terminal from readme...
danielgordon-switch-ev
force-pushed
the
docs/restructure-readme/1924
branch
from
9c4e0d6 to
9f2ef0a
Compare
tropxy
force-pushed
the
docs/restructure-readme/1924
branch
from
9f2ef0a to
f103a78
Compare
tropxy
approved these changes
May 23, 2022
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.
This PR reorganizes the readme so that it better presents the information the user needs to get up and running locally.
It also changes one of the make commands to use Poetry rather than pip, and adds a recommendation to use
poetry shellin local development -- this automatically activates the appropriate virtual environment once it is created.One question @tropxy @shalinnijel2 : Was docker-compose.prod.yml intended to be used for production at some point? I understand we're not going to be deploying with Docker -- is this obsolete?