X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;ds=sidebyside;f=README;fp=README;h=d693c6a91679e1b57d80fcd06eab7e04895855ac;hb=d43c4f45ab36a4bd547b0fbbcdeff887bc4ce5ab;hp=0000000000000000000000000000000000000000;hpb=daa0045f21c29bd608123a1da9bd1d0db664cbb1;p=wmpus

diff --git a/README b/README
new file mode 100644
index 0000000..d693c6a
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+wmpus - a cross platform window manager
+=======================================
+wmpus is a lightweight window manager for X11 and MS Windows
+
+
+Instalation
+-----------
+Installing on X11:
+
+    make
+    cp wmpus /usr/local/bin
+
+Building for Win32:
+
+    make SYS=win32
+
+
+Hacking
+-------
+The source code is organized around several generic interfaces coresponding to
+the header files in this directory. The window manager (wm) and system (sys)
+interfaces can have multiple implementations which are chosen at link time by
+including the desired object file.
+
+For example, sys-x11.c and sys-win32.c are mutually exclusive impelmentations
+of the sys interface.
+
+
+More info
+---------
+See the wiki for more details
+
+    http://lug.rose-hulman.edu/code/projects/wmpus/wiki