aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2016-12-30 05:36:06 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2016-12-30 05:45:53 +0100
commitbc631570c3b3875e8a03ecbbe6dfee483fb82053 (patch)
tree6cab8dfb5bc6627b797c68c95be91e71a2219012 /README.adoc
parentdc33535bbbeef4fd2c15cde1eda9d0b858c5f615 (diff)
downloadhex-bc631570c3b3875e8a03ecbbe6dfee483fb82053.tar.gz
hex-bc631570c3b3875e8a03ecbbe6dfee483fb82053.tar.xz
hex-bc631570c3b3875e8a03ecbbe6dfee483fb82053.zip
Finishing touches for an early release
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.adoc b/README.adoc
index 6f550f1..334add0 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,12 +1,15 @@
hex
===
-'hex' is yet another hex viewer. As of now, there are no advantages to it.
+'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.
+
+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.
+using a set of Lua scripts, colorize them and show descriptions on the side.
Packages
--------
@@ -41,7 +44,8 @@ Or you can try telling CMake to make a package for you. For Debian it is:
Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
`fakeroot` or file ownership will end up wrong.
-Having the program installed, optionally create a configuration file and run it.
+Having the program installed, optionally create a configuration file and run it
+on a file of your choice.
Configuration
-------------
@@ -50,9 +54,9 @@ Create _~/.config/hex/hex.conf_ with contents like the following:
....
colors = {
footer = ""
- highlight = "bold"
+ footer_hl = "bold"
bar = "reverse"
- bar_active = "ul"
+ bar_hl = "reverse bold"
even = ""
odd = ""
selection = "reverse"