Skip to content

Commit e65b6ff

Browse files
committed
Added new README.md for GitHub
1 parent 3eabf02 commit e65b6ff

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# MLVWM
2+
3+
## OVERVIEW
4+
5+
MLVWM (Macintosh-Like Virtual Window Manager) is an X11 window manager with a classic MacOS appearance. Its primary features include:
6+
7+
* Emulation of MacOS 7 & 8 menu bar & window decorations
8+
* Optional multiple virtual desktops
9+
* A main menu bar across the top of the screen, with:
10+
* Configurable global and per-application menus
11+
* Menu items trigger application functionality via keyboard shorcuts or commands
12+
* An icon menu which shows all windows and supports:
13+
* Switching desktops
14+
* Selecting, hiding, and showing windows
15+
* A balloon help menu
16+
* The ability to "swallow" small windows into the menu bar
17+
* Windows which support:
18+
* Title bars with optional close, zoom, and shade buttons
19+
* Resize handle
20+
* Optional double-click to toggle window shade
21+
* Drag as solid window or just outline
22+
* Balloon help which shows X window information
23+
* Global keyboard shortcuts
24+
* Numerous configuration options to tune functionality
25+
26+
## INSTALLATION
27+
28+
Build & installation currently still requires [imake](https://en.wikipedia.org/wiki/Imake) & make. While the original documentation says that `xmkmf -a` should work, we've found it's usually necessary to do the following:
29+
30+
cd man && xmkmf && cd -
31+
cd sample_rc && xmkmf && cd -
32+
cd mlvwm && xmkmf && cd -
33+
xmkmf
34+
make && make install
35+
36+
## CONFIGURATION
37+
38+
While some sample configuration files are included in the `sample_rc` directory, we highly suggest using the configuration files from the [mlvwmrc](https://github.com/morgant/mlvwmrc) project.
39+
40+
## DOCUMENTATION
41+
42+
We suggest reading the manual page (`man mlvwm`; English), but you may also find the original documentation helpful:
43+
44+
* README: [English](README), [日本語](README.jp)
45+
* CONFIGURATION: [English](CONFIGURATION), [日本語](CONFIGURATION.jp)
46+
* CHANGELOG: [English](CHANGELOG), [日本語](CHANGELOG.jp)
47+
* Website: [English](http://www2u.biglobe.ne.jp/~y-miyata/mlvwm.html)
48+
49+
Note: the English documentation above was automatically generated from the Japanese documentation.
50+
51+
## HISTORY
52+
53+
MLVWM was originally developed in 1997 by Takashi HASEGAWAi, based on FVWM, while studying at Nagoya University. Active development proceeded through 2000. In 2020, Morgan Aldridge obtained permission to continue maintenance & development.
54+
55+
## LICENSE
56+
57+
This software is distributed as freeware as long as the original copyright remains in the source code and all documentation. Some files retain their original MIT license and one file is in the public domain.
58+
59+
Macintosh and MacOS are registered trademarks of Apple, Inc. (née Apple Computer, Inc.)

0 commit comments

Comments
 (0)