Skip to content

Commit

Permalink
Mentioned tested OS/Terminal configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
rstemmer committed Oct 24, 2023
1 parent 29e66a4 commit c62fe80
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ libprinthex provides a function to print a hex dump with colored sections.

**Project State:** Alive and maintained

Tested on Linux with Konsole and MacOS with Terminal

## Installation

You should check the `install.sh` script before executing.
Expand Down Expand Up @@ -38,14 +40,14 @@ It should be less or equal to the buffer _buffer_ points to.
##### int bytesperline
This parameter determines how many bytes will be printed in each line.
A good argment would be `16`.
A good argument would be `16`.
##### ...
The optional arguments are in alternating _offset_ and _color_.
There can be as many pairs of _offset_ and _color_ as there are bytes in the _buffer_.
When the internal index to the values inside the buffer reached _offset_, the new text _color_ gets read from the argument list.
Furthermore the next _offset_ will be read. So the algorithm expects an infinit list of offsets and colors.
Furthermore the next _offset_ will be read. So the algorithm expects an infinite list of offsets and colors.
The last value has to be an offset that will never be reached (a good value is `-1`).
The _offset_ must be an integer between `0` and `bytesperline - 1`.
Expand Down

0 comments on commit c62fe80

Please sign in to comment.