aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarstr\xf6m <john@ankarstrom.se>2021-05-29 13:20:05 +0200
committerJohn Ankarstr\xf6m <john@ankarstrom.se>2021-05-29 13:20:05 +0200
commitd2c39c274907aef944ab47447c3515d1552d13e2 (patch)
tree73ae422d2f1beacffdeb0bd69cd859cbaa777713
parent36ccc24d65392e9033b08055b13664cc3b6fafe7 (diff)
downloadjwm-d2c39c274907aef944ab47447c3515d1552d13e2.tar.gz
README: Add information about fork
-rw-r--r--README26
1 files changed, 23 insertions, 3 deletions
diff --git a/README b/README
index ced403b..48e05f7 100644
--- a/README
+++ b/README
@@ -1,12 +1,20 @@
-JWM
+JWM is an X11 window manager created by Joe Wing. The version in
+this repository is a fork of JWM 1.8, maintained by John Ankarstr\xf6m
+<john@ankarstrom.se>.
+
See LICENSE for license information.
+> Functionality
+JWM 1.8 was originally released in 2006. As such, some of the code
+is outdated. For example, bi-directional text support is currently
+broken. That means you must pass --disable-fribidi to configure.
+
> Requirements
To build JWM you will need a C compiler (gcc works), X11, and the
"development headers" for X11 and Xlib.
If available and not disabled at compile time, JWM will also use
the following libraries:
- libfribidi for bi-directional text support.
+ libfribidi for bi-directional text support (broken).
libXext for the shape extension.
libXext for the render extension.
libXinerama for multiple head support.
@@ -20,5 +28,17 @@ Run "./configure [options]"
Run "make" to build JWM.
Run "make install" to install JWM.
-For more information see http://joewing.net
+As bi-directional text support is currently broken, you should pass
+the following flag to configure:
+
+ ./configure --disable-fribidi
+
+If you're installing on NetBSD, you might want to pass the following
+flag to configure:
+
+ ./configure --mandir=\$PREFIX/man
+
+as the default mandir is $PREFIX/share/man.
+
+For more information about JWM, see http://joewing.net