Skip to content

Commit

Permalink
Showcase the parser feature in the README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Arnau478 committed Jul 4, 2024
1 parent 2d8ac4a commit 8743630
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,15 @@
![example image](web/example.png)

## What is hevi?
Hevi is a hex viewer, just like `xxd` or `hexdump`.
Hevi (pronounced like "heavy") is a hex viewer, just like `xxd` or `hexdump`.

## But it's missing X...
Hevi is under development. But if you think it's missing any feature, please open an issue. I will address it as soon as possible.
## Features
### Parsers
Hevi can parse things like ELF or PE files and give you syntax-highlighting.
![parser example](web/parser.png)

### Custom color palettes
You can specify custom color palettes. Color palettes can use standard ANSI colors or truecolor.

## Usage
The command should be used as `hevi <file> [flags]`. The flags are described [below](#flags).
Expand Down
Binary file modified web/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/parser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8743630

Please sign in to comment.