Improve README #2814
Merged
Improve README #2814
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
itchyny
reviewed
Aug 1, 2023
Improve README to be more structural and more readable.
itchyny
reviewed
Aug 2, 2023
| ```console | ||
| git submodule update --init # if building from git to get oniguruma | ||
| autoreconf -i # if building from git | ||
| ./configure --with-oniguruma=builtin |
There was a problem hiding this comment.
I always feel --with-oniguruma=builtin in instruction is verbose because it detects automatically but do we still need this to prevent the fallback to pre-installed libonig?
There was a problem hiding this comment.
Indeed, the --with-oniguruma=builtin is in the default ./configure flags: . Perhaps let's make the help more clear builtin is the default.
There was a problem hiding this comment.
I guess this is going to be more reliable for users, so it's probably best to leave it. Users with a slight clue will think about this and maybe exclude this option?
nicowilliams
reviewed
Aug 2, 2023
nicowilliams
reviewed
Aug 2, 2023
nicowilliams
reviewed
Aug 2, 2023
nicowilliams
reviewed
Aug 2, 2023
|
LGTM. |
itchyny
approved these changes
Aug 3, 2023
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.
Improve README to be more structural and more readable. A reander is available here.