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.

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

Clarify direnv setup instructions #1437

Merged
merged 2 commits into from
Apr 21, 2024
Merged

Conversation

mkoval
Copy link
Contributor

@mkoval mkoval commented Apr 21, 2024

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!

README.md Outdated Show resolved Hide resolved
@onedr0p onedr0p merged commit 2e2c53d into onedr0p:main Apr 21, 2024
4 checks passed
@onedr0p
Copy link
Owner

onedr0p commented Apr 21, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants