diff options
author | Jonas Ådahl <jadahl@gmail.com> | 2018-07-30 20:55:31 +0200 |
---|---|---|
committer | Jonas Ådahl <jadahl@gmail.com> | 2018-07-30 21:58:59 +0200 |
commit | eb0865fe11ee70a43754645aff1b654fce1b4466 (patch) | |
tree | b87c4afed4672ef8958f6406964f0ab435d522a6 /README.md | |
parent | e283cd7b91d97946e7bb1cca0c5fcfac41fe3f68 (diff) | |
download | mutter-eb0865fe11ee70a43754645aff1b654fce1b4466.tar.gz |
Add README.md
The welcome page on Gitlab is pretty boring for mutter. Improve that a
bit by adding a README file with some basic introduction.
Fixes: https://gitlab.gnome.org/GNOME/mutter/issues/245
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..77a8ad953 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Mutter + +Mutter is a Wayland display server and X11 window manager and compositor library. + +When used as a Wayland display server, it runs on top of KMS and libinput. It +implements the compositor side of the Wayland core protocol as well as various +protocol extensions. It also has functionality related to running X11 +applications using Xwayland. + +When used on top of Xorg it acts as a X11 window manager and compositing manager. + +It contains functionality related to, among other things, window management, +window compositing, focus tracking, workspace management, keybindings and +monitor configuration. + +Internally it uses a fork of Cogl, a hardware acceleration abstraction library +used to simplify usage of OpenGL pipelines, as well as a fork af Clutter, a +scene graph and user interface toolkit. + +Mutter is used by GNOME Shell, the GNOME core user interface. It can also be run +standalone, using the command "mutter", but just running plain mutter is only +intended for debugging purposes. + +## License + +Mutter is distributed under the terms of the GNU General Public License, +version 2 or later. See the [COPYING][license] file for detalis. + +[bug-tracker]: https://gitlab.gnome.org/GNOME/mutter/issues +[license]: COPYING |