From 85e100a3a1971b514b7f714e1385037489a8533f Mon Sep 17 00:00:00 2001
From: Leon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de>
Date: Mon, 14 Aug 2023 02:12:13 +0200
Subject: [PATCH] add manpage and README

---
 README    |  5 +++++
 wayneko.1 | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)
 create mode 100644 README
 create mode 100644 wayneko.1

diff --git a/README b/README
new file mode 100644
index 0000000..0b17aab
--- /dev/null
+++ b/README
@@ -0,0 +1,5 @@
+wayneko - Neko on Wayland
+
+Display an animated neko cat on the bottom of an output. Requires the Wayland
+server to implement zwlr-layer-shell-unstable-v1.  All code is licensed under
+the GPLv3. The neko bitmaps were taken from public domain.
diff --git a/wayneko.1 b/wayneko.1
new file mode 100644
index 0000000..8963197
--- /dev/null
+++ b/wayneko.1
@@ -0,0 +1,58 @@
+.TH WAYNEKO 1 2023-08-14 "git.sr.ht/~leon_plickat/wayneko" "General Commands Manual"
+.
+.SH NAME
+.P
+wayneko \- Neko on Wayland
+.
+.
+.SH SYNOPSIS
+.SY wayneko
+.OP \-h
+.OP \-\-help
+.OP \-?
+.YS
+.
+.SY wayneko
+.OP \-\-background\-colour 0xRRGGBB[AA]
+.OP \-\-outline\-colour 0xRRGGBB[AA]
+.YS
+.
+.
+.SH DESCRIPTION
+.P
+Display an animated neko cat on the bottom of an output.
+.P
+Requires the Wayland server to implement \fBzwlr-layer-shell-unstable-v1\fR.
+.
+.
+.SH OPTIONS
+.P
+\fB\-h\fR, \fB\-\-help\fR, \fB\-?\fR
+.RS
+Print help text and exit.
+.RE
+.
+.P
+\fB\-\-background\-colour\fR \fI0xRRGGBB[AA]\fR
+.RS
+Set the background fill colour using a hexadecimal colour code prefixed by '0x'.
+Alpha value is optional.
+.RE
+.
+.P
+\fB\-\-outline\-colour\fR \fI0xRRGGBB[AA]\fR
+.RS
+Set the outline colour using a hexadecimal colour code prefixed by '0x'.
+Alpha value is optional.
+.RE
+.
+.
+.SH AUTHOR
+.P
+Code by
+.MT leonhenrik.plickat@stud.uni-goettingen.de
+Leon Henrik Plickat
+.ME .
+.
+.P
+Neko bitmaps taken from public domain.