Skip to content

docs: add color and character legend to README (fixes #240) #281

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.

Sign up for GitHub

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

Closed
wyf027 wants to merge 1 commit into from
Closed

docs: add color and character legend to README (fixes #240) #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,27 @@ of bytes (NULL bytes, printable ASCII characters, ASCII whitespace characters, o

## Preview

With the default color scheme and character table, the three panels use the following colors and
characters (run `hexyl --print-color-table` to see them in your terminal):

| Panel | Color | Character / example | Byte category |
| ----- | ----- | ------------------- | ------------- |
| Offset (left) | bright black | `00000000` | file position |
| Hex (middle) | bright black | `00` | NULL bytes (`0x00`) |
| Hex (middle) | cyan | `61` | ASCII printable (`0x20`–`0x7E`) |
| Hex (middle) | green | `20` | ASCII whitespace (`0x09`–`0x0D`, `0x20`) |
| Hex (middle) | green | `7f` | other ASCII control characters |
| Hex (middle) | yellow | `ff` | non-ASCII bytes (`0x80`–`0xFF`) |
| ASCII (right) | bright black | `⋄` | NULL bytes |
| ASCII (right) | as-is | `a` | printable ASCII |
| ASCII (right) | `_` or space | space / tab / newline | ASCII whitespace |
| ASCII (right) | `•` | bullet | other ASCII control characters |
| ASCII (right) | `×` | multiplication sign | non-ASCII bytes |

An alternative gradient palette is available via `--color-scheme gradient`.

Examples:

![](https://i.imgur.com/MWO9uSL.png)

![](https://i.imgur.com/Dp7Wncz.png)
Expand Down
Loading