From 9176f5d87ee2013216cdde547eb0c265e6ac16b8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se>
Date: Tue, 2 May 2023 21:08:43 +0200
Subject: Add README.

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

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
-- 
cgit v1.2.3