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-27 01:35:08 +01:00
parent 973d12a84e
commit 416b52083d
Signed by: p
GPG Key ID: B715679E3A361BE6
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.adoc
View File

@ -5,7 +5,7 @@ hex
files using a set of Lua scripts, colorizing them and showing descriptions on files using a set of Lua scripts, colorizing them and showing descriptions on
the side. the side.
At the moment the project is still in a very early stage. At the moment there aren't that many features and we only have a few decoders.
image::hex.png[align="center"] image::hex.png[align="center"]
@ -69,16 +69,22 @@ following:
- Xterm needs `XTerm*metaSendsEscape: true` for the default bindings to work - Xterm needs `XTerm*metaSendsEscape: true` for the default bindings to work
- urxvt's 'vtwheel' plugin sabotages scrolling - urxvt's 'vtwheel' plugin sabotages scrolling
Performance
-----------
While the Lua API has been made considerably easy to write new decoders with,
the design is far from efficient as we make tons of new formatted strings.
Since we need Lua 5.3 features (64-bit integers), LuaJIT can't help us here.
Similar software
----------------
https://codisec.com/veles/ can also highlight files but it's not scriptable.
Contributing and Support Contributing and Support
------------------------ ------------------------
Use this project's GitHub to report any bugs, request features, or submit pull 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>.