p
/
hex
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

This commit is contained in:
Přemysl Eric Janouch 2017-01-17 14:46:14 +01:00
parent 1c1facb836
commit 1aa043324c
Signed by: p
GPG Key ID: B715679E3A361BE6
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.adoc
View File

@ -1,16 +1,14 @@
hex hex
=== ===
'hex' is yet another hex viewer. Right now there are no advantages to it as it 'hex' is yet another hex viewer. It automatically interprets fields within
has almost no features at all at this stage. files using a set of Lua scripts, colorizing them and showing descriptions on
the side.
At the moment the project is still in a very early stage.
image::hex.png[align="center"] image::hex.png[align="center"]
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.
Packages Packages
-------- --------
Regular releases are sporadic. git master should be stable enough. You can get Regular releases are sporadic. git master should be stable enough. You can get
@ -24,7 +22,7 @@ Building and Running
-------------------- --------------------
Build dependencies: CMake, pkg-config, help2man, liberty (included), Build dependencies: CMake, pkg-config, help2man, liberty (included),
termo (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 $ git clone --recursive https://github.com/pjanouch/hex.git
$ mkdir hex/build $ 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 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. 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 License
------- -------
'hex' is written by Přemysl Janouch <p.janouch@gmail.com>. 'hex' is written by Přemysl Janouch <p.janouch@gmail.com>.