Skip to content

docs: add color and glyph legend under README Preview #284

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

Open
Solaris-star wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add color and glyph legend under README Preview #284

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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,25 @@ of bytes (NULL bytes, printable ASCII characters, ASCII whitespace characters, o

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

### Color and character legend

With the default character table and color scheme, each byte category is shown
as follows (hex panel uses the color; the right-hand character panel uses the
glyph):

| Category | Default color | Glyph | Byte range |
| --- | --- | --- | --- |
| NULL bytes | bright black | `⋄` | `0x00` |
| ASCII printable | cyan | as-is (`a`–`z`, …) | `0x20`–`0x7E` |
| ASCII whitespace | green | space or `_` | `0x09`–`0x0D`, `0x20` |
| Other ASCII (controls) | green | `•` | remaining `0x01`–`0x1F`, `0x7F` |
| Non-ASCII | yellow | `×` | `0x80`–`0xFF` |

You can print a live color reference with:

```bash
hexyl --print-color-table
```

## Installation

Expand Down
Loading