93e0265e4e
Once in a while, we receive complaints from other fellow KDE developers about the file organization of kwin. This change addresses some of those complaints by moving all of source code in a separate directory, src/, thus making the project structure more traditional. Things such as tests are kept in their own toplevel directories. This change may wreak havoc on merge requests that add new files to kwin, but if a patch modifies an already existing file, git should be smart enough to figure out that the file has been relocated. We may potentially split the src/ directory further to make navigating the source code easier, but hopefully this is good enough already. |
||
|---|---|---|
| autotests | ||
| cmake/modules | ||
| data | ||
| doc | ||
| kconf_update | ||
| LICENSES | ||
| src | ||
| tests | ||
| .gitignore | ||
| CMakeLists.txt | ||
| HACKING.md | ||
| KWinDBusInterfaceConfig.cmake.in | ||
| logo.png | ||
| Mainpage.dox | ||
| plasma-kwin_wayland.service.in | ||
| plasma-kwin_x11.service.in | ||
| README.md | ||
| TESTING.md | ||
KWin
KWin is an easy to use, but flexible, composited Window Manager for Xorg windowing systems (Wayland, X11) on Linux. Its primary usage is in conjunction with a Desktop Shell (e.g. KDE Plasma Desktop). KWin is designed to go out of the way; users should not notice that they use a window manager at all. Nevertheless KWin provides a steep learning curve for advanced features, which are available, if they do not conflict with the primary mission. KWin does not have a dedicated targeted user group, but follows the targeted user group of the Desktop Shell using KWin as it's window manager.
KWin is not...
- a standalone window manager (c.f. openbox, i3) and does not provide any functionality belonging to a Desktop Shell.
- a replacement for window managers designed for use with a specific Desktop Shell (e.g. GNOME Shell)
- a minimalistic window manager
- designed for use without compositing or for X11 network transparency, though both are possible.
Contacting KWin development team
- mailing list: kwin@kde.org
- IRC: #kwin on freenode
Support
Application Developer
If you are an application developer having questions regarding windowing systems (either X11 or Wayland) please do not hesitate to contact us. Preferable through our mailing list. Ideally subscribe to the mailing list, so that your mail doesn't get stuck in the moderation queue.
End user
Please contact the support channels of your Linux distribution for user support. The KWin development team does not provide end user support.
Reporting bugs
Please use KDE's bugtracker and report for product KWin.
Developing on KWin
Please refer to hacking documentation for how to build and start KWin. Further information about KWin's test suite can be found in TESTING.md.
Guidelines for new features
A new Feature can only be added to KWin if:
- it does not violate the primary missions as stated at the start of this document
- it does not introduce instabilities
- it is maintained, that is bugs are fixed in a timely manner (second next minor release) if it is not a corner case.
- it works together with all existing features
- it supports both single and multi screen (xrandr)
- it adds a significant advantage
- it is feature complete, that is supports at least all useful features from competitive implementations
- it is not a special case for a small user group
- it does not increase code complexity significantly
- it does not affect KWin's license (GPLv2+)
All new added features are under probation, that is if any of the non-functional requirements as listed above do not hold true in the next two feature releases, the added feature will be removed again.
The same non functional requirements hold true for any kind of plugins (effects, scripts, etc.). It is suggested to use scripted plugins and distribute them separately.