docs: add color and glyph legend under README Preview - #284
Open
Solaris-star wants to merge 1 commit into
Open
Conversation
Document the default category → color/glyph mapping so the preview screenshots are easier to read. Point readers at --print-color-table for a live reference. Closes sharkdp#240. Signed-off-by: Solaris-star <820622658@qq.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
The Preview screenshots show colored bytes and glyphs, but the README did not map those colors/icons to byte categories.
Add a short legend under Preview documenting the default category → color → glyph mapping (aligned with
print_color_table/ default character table), and mentionhexyl --print-color-tablefor a live reference.Closes #240.
Testing
src/main.rs(print_color_table) andsrc/lib.rs(as_charfor the default character table)