From 3893978f1859e28d8abaf483b69957022554f03d Mon Sep 17 00:00:00 2001
From: Bob Polis <bob.polis@gmail.com>
Date: Wed, 27 Nov 2024 16:54:02 +0100
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0c443cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# termage — Color images in the terminal
+
+True color if the terminal supports it, otherwise falls back to small palette.
+
+`termage` uses ImageMagick to convert your image to ppm format, properly scaled
+as well,, which is fed to `termage` for display.
+
+## Build
+
+`make`
+
+after building and installing dependencies:
+
+- [libscerror](https://git.bobpolis.com/bob/libscerror/)
+- [libscstring](https://git.bobpolis.com/bob/libscstring/)
+- [libscterm](https://git.bobpolis.com/bob/libscterm/)
+- NetPBM (development library)
+- ImageMagick (tools)
+
+## Install
+
+`sudo make install`
+
+or, on OpenBSD:
+
+`doas gmake install`
+
+## Run
+
+`termage <image file>`
+
+: Shows given image file in the terminal.