Clarify direnv setup instructions #1437
Merged
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.
I missed the
task workstation:direnv
command in the README because of the way it is formatted. Instead of being called out in a code block, like the other steps, it is inlined as part of another step. It is also not obvious how to tell whether the setup was successful.This sent me down a bit of a rabbit hole because several of the following steps fail in surprising ways (e.g. TLS errors) when the env variables are missing. I thought I had setup
direnv
correctly, but actually had missed a step.This PR modifies the README to callout
task workstation:direnv
as a separate step and explains how to check whether it was successful. Hopefully this will will prevent someone else from going down the same rabbit hole. 😄P.S.
direnv
is really neat! I am going to start using it everywhere!