[gen-readme] Improve gen readme #1735
Merged
Conversation
This file contains hidden or 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
savil
approved these changes
Jan 24, 2024
| Start the devbox shell: | ||
| ```sh | ||
| devbox shell | ||
| ``` |
There was a problem hiding this comment.
WDYT about nudging people towards using direnv as well? It tends to be significantly faster than starting a devbox shell (since we don't start a new shell process)
There was a problem hiding this comment.
Feels weird to me since I personally don't use it (I tend to use devbox run a lot which is faster than shell).
Feels a bit prescriptive no? i.e. devbox is absolutely needed to develop on this repo, but direnv is more a matter of opinion?
Anyway, a follow up to this could be to allow people to specify their own readme templates so they can modify as needed.
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.
Summary
Improve automatically generated readme. Highlights:
What it looks like: https://github.com/jetpack-io/devbox/blob/56e7427a8f3da266d2f3d2b4a5028a7c7a017fc3/devbox.md
How was it tested?
devbox gen readme devbox.md