diff options
author | Přemysl Eric Janouch <p@janouch.name> | 2023-06-15 22:32:02 +0200 |
---|---|---|
committer | Přemysl Eric Janouch <p@janouch.name> | 2023-06-15 22:32:02 +0200 |
commit | 62c6d43ca327dcbf8832b3a210a41e1b822da593 (patch) | |
tree | bac298d5e56247252ad65ce2c5fe6c9a5786ec9c /README.adoc | |
parent | ccb39748958c4278d9747e22aa2484ad40fb68a3 (diff) | |
download | hex-62c6d43ca327dcbf8832b3a210a41e1b822da593.tar.gz hex-62c6d43ca327dcbf8832b3a210a41e1b822da593.tar.xz hex-62c6d43ca327dcbf8832b3a210a41e1b822da593.zip |
Add a real manual page
Diffstat (limited to 'README.adoc')
-rw-r--r-- | README.adoc | 25 |
1 files changed, 7 insertions, 18 deletions
diff --git a/README.adoc b/README.adoc index d8cdb08..f2b23d1 100644 --- a/README.adoc +++ b/README.adoc @@ -14,10 +14,15 @@ Packages Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinux's AUR. +Documentation +------------- +See the link:hex.adoc[man page] for information about usage. +The rest of this README will concern itself with externalities. + Building and Running -------------------- -Build dependencies: CMake, pkg-config, help2man, liberty (included), - termo (included) + +Build dependencies: CMake, pkg-config, awk, liberty (included), + termo (included), asciidoctor or asciidoc (recommended but optional) + Runtime dependencies: ncursesw, libunistring, Lua >= 5.3 (for highlighting) $ git clone --recursive https://git.janouch.name/p/hex.git @@ -38,22 +43,6 @@ Or you can try telling CMake to make a package for you. For Debian it is: Having the program installed, optionally create a configuration file and run it on a file of your choice. -Configuration -------------- -Create _~/.config/hex/hex.conf_ with contents like the following: - -.... -colors = { - footer = "" - footer_hl = "bold" - bar = "reverse" - bar_hl = "reverse bold" - even = "" - odd = "" - selection = "reverse" -} -.... - Terminal caveats ---------------- Terminals are somewhat tricky to get consistent results on, so be aware of the |