aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59ec94c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+Hex Viewer
+==========
+An interactive hex viewer which highlights related bytes.
+
+Building and Running
+--------------------
+
+Requires that `ncurses` and `chibi-scheme` is installed and linkable.
+To build, run:
+
+ make ui
+
+See Makefile for further information.
+
+Currently only supports gzip files.
+
+Future direction
+----------------
+- Support more filetypes
+- Support magic(5) do automatically determine filetype
+- Nested groups, many formats specify sub-formats within blocks
+- Show blocks before they are hoovered over