diff options
| author | Přemysl Janouch <p.janouch@gmail.com> | 2017-01-17 14:46:14 +0100 |
|---|---|---|
| committer | Přemysl Janouch <p.janouch@gmail.com> | 2017-01-17 15:51:08 +0100 |
| commit | 1aa043324cf848443dee961be50e67391f1fdff2 (patch) | |
| tree | 883bb315b274195f732fb9cf005fc0a7aa7a787a /README.adoc | |
| parent | 1c1facb836d9d93542e212a57632ec3feb36851d (diff) | |
| download | hex-1aa043324cf848443dee961be50e67391f1fdff2.tar.gz hex-1aa043324cf848443dee961be50e67391f1fdff2.tar.xz hex-1aa043324cf848443dee961be50e67391f1fdff2.zip | |
Update README
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/README.adoc b/README.adoc index 334add0..cbfb90f 100644 --- a/README.adoc +++ b/README.adoc @@ -1,15 +1,13 @@ hex === -'hex' is yet another hex viewer. Right now there are no advantages to it as it -has almost no features at all at this stage. +'hex' is yet another hex viewer. It automatically interprets fields within +files using a set of Lua scripts, colorizing them and showing descriptions on +the side. -image::hex.png[align="center"] +At the moment the project is still in a very early stage. -Plans ------ -In the future, it should be able to automatically interpret fields within files -using a set of Lua scripts, colorize them and show descriptions on the side. +image::hex.png[align="center"] Packages -------- @@ -24,7 +22,7 @@ Building and Running -------------------- Build dependencies: CMake, pkg-config, help2man, liberty (included), termo (included) + -Runtime dependencies: ncursesw, libunistring +Runtime dependencies: ncursesw, libunistring, Lua >= 5.3 (for highlighting) $ git clone --recursive https://github.com/pjanouch/hex.git $ mkdir hex/build @@ -77,6 +75,10 @@ Use this project's GitHub to report any bugs, request features, or submit pull requests. If you want to discuss this project, or maybe just hang out with the developer, feel free to join me at irc://irc.janouch.name, channel #dev. +Similar software +---------------- +https://codisec.com/veles/ can also highlight files but it's not scriptable. + License ------- 'hex' is written by Přemysl Janouch <p.janouch@gmail.com>. |