[update] add man pages, update readme

Makefile

@@ -1,5 +1,7 @@
 DAEMON_BINARY := swhkd
 SERVER_BINARY := swhks
+DAEMON_MAN_PAGE := swhkd.1
+SERVER_MAN_PAGE := swhks.1
 BUILDFLAGS := --release
 POLKIT_DIR := /etc/polkit-1/rules.d
 POLKIT_RULE := swhkd.rules
@@ -31,11 +33,17 @@ install:
 	@cp ./$(POLKIT_RULE) $(POLKIT_DIR)/$(POLKIT_RULE)
 	@chmod +x $(TARGET_DIR)/$(DAEMON_BINARY)
 	@chmod +x $(TARGET_DIR)/$(SERVER_BINARY)
+	@cp ./docs/man/$(DAEMON_MAN_PAGE) /usr/local/man/man1/$(DAEMON_MAN_PAGE)
+	@cp ./docs/man/$(SERVER_MAN_PAGE) /usr/local/man/man1/$(SERVER_MAN_PAGE)
+	@chmod 755 /usr/local/man/man1/$(DAEMON_MAN_PAGE)
+	@chmod 755 /usr/local/man/man1/$(SERVER_MAN_PAGE)
 
 uninstall:
 	@rm $(TARGET_DIR)/$(SERVER_BINARY)
 	@rm $(TARGET_DIR)/$(DAEMON_BINARY)
 	@rm $(POLKIT_DIR)/$(POLKIT_RULE)
+	@rm /usr/local/man/man1/$(DAEMON_MAN_PAGE)
+	@rm /usr/local/man/man1/$(SERVER_MAN_PAGE)
 
 check:
 	@cargo fmt

docs/INSTALL.md

@@ -0,0 +1,25 @@
+## Installation
+
+# Dependencies:
+
+## Runtime:
+
+-   Policy Kit Daemon ( polkit )
+
+## Compile time:
+
+-   `rustup`
+-   `make`
+
+# Compiling:
+
+-   `git clone https://github.com/shinyzenith/swhkd`
+-   `make setup`
+-   `make clean`
+    -   `make` for a musl compile.
+    -   `make glibc` for a glibc compile.
+-   `sudo make install`
+
+# Running:
+
+`pkexec swhkd`

docs/man/swhkd.1

@@ -0,0 +1,27 @@
+.\" Automatically generated by Pandoc 2.14.2
+.\"
+.TH "" "" "" "" ""
+.hy
+.SH SWHKD
+.PP
+\f[B]S\f[R]imple \f[B]W\f[R]ayland \f[B]H\f[R]ot\f[B]K\f[R]ey
+\f[B]D\f[R]aemon
+.PP
+swhkd is a display protocol-independent hotkey daemon made in Rust.
+.PP
+swhkd uses an easy-to-use configuration system inspired by sxhkd so you
+can easily add or remove hotkeys.
+.PP
+It is also a drop-in replacement for sxhkd, meaning, your sxhkd config
+file is also compatible with swhkd.
+.PP
+Because swhkd can be used anywhere, the same swhkd config can be used
+across Xorg or Wayland desktops, and you can even use swhkd in a tty.
+.PP
+\f[B]Note: The project isn\[cq]t complete yet.\f[R]
+.SH RUNNING
+.PP
+\f[C]pkexec swhkd\f[R]
+.SH SEE ALSO
+.PP
+swhks(1)

docs/man/swhkd.md

@@ -0,0 +1,21 @@
+# SWHKD
+
+**S**imple **W**ayland **H**ot**K**ey **D**aemon
+
+swhkd is a display protocol-independent hotkey daemon made in Rust.
+
+swhkd uses an easy-to-use configuration system inspired by sxhkd so you can easily add or remove hotkeys.
+
+It is also a drop-in replacement for sxhkd, meaning, your sxhkd config file is also compatible with swhkd.
+
+Because swhkd can be used anywhere, the same swhkd config can be used across Xorg or Wayland desktops, and you can even use swhkd in a tty.
+
+**Note: The project isn't complete yet.**
+
+# RUNNING
+
+`pkexec swhkd`
+
+# SEE ALSO
+
+swhks(1)

docs/man/swhks.1

@@ -0,0 +1,11 @@
+.\" Automatically generated by Pandoc 2.14.2
+.\"
+.TH "" "" "" "" ""
+.hy
+.SH SWHKS
+.PP
+swhks is the server that waits for signals from swhkd to execute
+commands as a non-root user.
+.SH SEE ALSO
+.PP
+swhkd(1)

docs/man/swhks.md

@@ -0,0 +1,7 @@
+# SWHKS
+
+swhks is the server that waits for signals from swhkd to execute commands as a non-root user.
+
+# SEE ALSO
+
+swhkd(1)