docs: add details discovered in running locally #43
Conversation
| Then follow the instructions to configure your desired version. | ||
|
|
There was a problem hiding this comment.
Thank you for adding these detailed instructions, Daniel. Also, as users are likely to try and start execute the code before reading through the entire document, do you think it would help to point out the .env settings here, right after the java update instructions? A comment suggesting - "Configure .env file as suggested here (https://github.com/SwitchEV/iso15118#environment-settings)" would suffice?
There was a problem hiding this comment.
That's definitely something I have in mind for my next PR -- to rearrange the existing information so that people are presented with what they need to get up and running right away. I thought it might be simpler to add the additional instructions first, then restructure the document in a second PR, since both together could be hard to follow.
README.md
Outdated
| @@ -130,6 +150,10 @@ it is required to create a `.env` file, containing the required settings. | |||
| This means, if development settings are desired, one can simply copy the contents | |||
| of `.env.dev.local` to `.env`. | |||
|
|
|||
| By default, `.env.dev.local` assumes the presence of an `eth0` network interface. | |||
| If you are not using ethernet, replace the `NETWORK_INTERFACE` value in your local `.env` | |||
There was a problem hiding this comment.
I guess you meant "if you are not using eth0 as your network interface, replace the ....
There was a problem hiding this comment.
Good point, will clarify.
This PR adds some details I learned in trying to get
make run-seccto succeed in a local installation.This is meant to be a quick PR with more to follow -- I think this could be restructured some more to make the setup process easier to follow, but will do that in a separate PR.
Another question: does this actually only run on Linux? If so, do we know why it doesn't run on MacOS? The final section, "Integration Test with an EV Simulator", indicates that it has been run successfully under Ubuntu, Debian, and MacOS (which versions?)