Use <details> in installation section #556
Open
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
If brew command is not working on linux, then this can also be used.
duesee
commented
Nov 3, 2023
| <summary>Build from source (requires Go 1.10+)</summary> | ||
|
|
||
| ```sh | ||
| <not documented yet> |
There was a problem hiding this comment.
The new structure made it explicit that this wasn't documented. I can't provide this information, but having it here signals that it's possible (of course :-)). We could also remove it.
duesee
commented
Nov 3, 2023
|
|
||
| ``` | ||
| <details> | ||
| <summary>APT (Debian, Ubuntu, ...)</summary> |
There was a problem hiding this comment.
These instructions are from the cherry-pick.
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.
Hello 👋🏻
First of all, thank you for this fantastic tool! It already saved me from countless hours fiddling with
openssl:-)This PR aims to improve the README so that you can quickly "choose" your preferred installation method (and don't have to look at other methods). I used two nested levels of
<details>. To quickly see if you like the result, you can open the rendered README in my fork.I cherry-picked the commit from #526 and already integrated it into the structure.
The structure allows you to expand only the methods you are interested in. The downside is that the README could become more challenging to maintain. However, I suspect it makes it also a bit easier to add new methods in the future.
If you like the idea -- I'm not sure about it :-) -- I can try to improve the aesthetics of the
<details>.