From ee81361cef63a270178ff8f39577b06759a4ba44 Mon Sep 17 00:00:00 2001
From: Wolfgang Müller
Date: Tue, 27 Apr 2021 12:47:51 +0200
Subject: Add README

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b8c1e88
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# cwm – a lightweight and efficient window manager for X11
+
+This is an opinionated port and fork of OpenBSD's cwm window manager to Linux.
+Unnecessary or obscure features have been removed whilst a few bugs have been
+patched. Future upstream fixes will be included.
+
+See [cwm(1)](cwm.1) and [cwmrc(5)](cwmrc.5).
+
+## Removed features
+
+ - Path completion in the exec menu
+ - The entire ssh menu
+ - The entire wm menu
+ - Matching on window title history
+
+## Added features and bugfixes
+
+ - XDG-compliant configuration file location
+ - Windows are automatically raised when fullscreened
+ - Warping to last active window if there is no active client
+ - Ignored clients are not shown in the window menu
+ - Colors are calculated using the client's visual and colormap,
+   enabling support for compositors
+ - A memory leak in conf_clear has been fixed
+ - A string truncation issue in menu_draw has been fixed
+
+See the respective commits for more information.
-- 
cgit v1.2.3-2-gb3c3