commit 9ca1b48bc0a1df56611a6827855160e000d0d521
parent e9e5dded8592ad7eca6dea9f38e6a59830f7594e
Author: wh1tepearl <wh1tepearl@gmail.com>
Date: Sat, 31 Jan 2026 21:40:06 +0000
Added readme
Diffstat:
2 files changed, 57 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,56 @@
+# vxwm - Versatile X Window Manager for x11
+
+## Requirements
+
+In order to build dwm you need the Xlib header files.
+
+# Getting Started:
+
+## Installation
+
+Edit config.mk to match your local setup (vxwm is installed into
+the /usr/local namespace by default).
+
+Enable Xinerama if you need it by uncommenting Xinerama libs in config.mk.
+
+Afterwards enter the following command to build and install vxwm (if
+necessary as root):
+
+ make clean install
+
+
+## Running vxwm
+
+Add the following line to your .xinitrc to start vxwm using startx:
+
+ exec vxwm
+
+If you want to restart vxwm without losing your session
+or for hot configuration reload, add something like this to your .xinitrc:
+
+ vxwm &
+ exec sleep infinity
+
+And then for restarting vxwm just kill vxwm's process and start it again.
+
+In order to connect vxwm to a specific display, make sure that
+the DISPLAY environment variable is set correctly, e.g.:
+
+ DISPLAY=foo.bar:1 exec vxwm
+
+(This will start vxwm on display :1 of the host foo.bar.)
+
+In order to display status info in the bar, you can do something
+like this in your .xinitrc:
+
+ while xsetroot -name "`date` `uptime | sed 's/.*,//'`"
+ do
+ sleep 1
+ done &
+ exec vxwm
+
+
+## Configuration
+
+The configuration of vxwm is done by editing config.h and modules.h to
+match your preferences and (re)compiling the source code.
diff --git a/config.mk b/config.mk
@@ -10,7 +10,7 @@ MANPREFIX = ${PREFIX}/share/man
X11INC = /usr/X11R6/include
X11LIB = /usr/X11R6/lib
-# Xinerama, comment if you don't want it
+# Xinerama, uncomment if you want it
# XINERAMALIBS = -lXinerama
# XINERAMAFLAGS = -DXINERAMA
