From f2aa28deb420987e6183086d66b2c2c43a98a256 Mon Sep 17 00:00:00 2001 From: Benjamin Chausse Date: Wed, 5 Jun 2024 23:48:12 -0400 Subject: Add demo and installation to README --- README.org | 33 ++++++++++++++++++++++++++++++++- demo.png | Bin 0 -> 144680 bytes 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 demo.png diff --git a/README.org b/README.org index 41cea86..152bfcb 100644 --- a/README.org +++ b/README.org @@ -1,6 +1,37 @@ -#+title: SiXKCD: XKCD comics in the sixel format #+author: Benjamin Chausse +* SiXKCD: XKCD comics in the sixel format + XKCD is great. What's even better is viewing his comics directly in your terminal using sixel graphics! +To achieve this, you need a terminal that supports it. +Here's a good reference to find one or learn if yours +already does: + +[[https://www.arewesixelyet.com/]] + +#+HTML:
+[[./demo.png]] +#+HTML:
+ +** Installation + +I'll probably create a =Makefile= in the future +to streamline the process. In the meantime, you +can build the binary in the following way. + +#+begin_src sh +# Creating the binary +go get download +go build -o sixkcd ./sixkcd.go +# Installing it on your system +sudo cp sixkcd /usr/local/bin +#+end_src + +Uninstalling is as simple as: + +#+begin_src sh +sudo rm /usr/local/bin/sixkcd +#+end_src + diff --git a/demo.png b/demo.png new file mode 100644 index 0000000..38bff5c Binary files /dev/null and b/demo.png differ -- cgit v1.2.3