Differential D17722

Add a new markdown README
ClosedPublic
Actions

Authored by graesslin on Dec 21 2018, 4:48 PM.

Details

Reviewers
zzag
Group Reviewers
KWin
Commits
R108:96496a8608db: Add a new markdown README
Summary

The old readme was targetted at application developers having
conceptional questions about window management. While we all know that
this is very often needed, I doubt that any application developer is
looking at KWin's README to figure out why their window doesn't get
focus.

The new README is focussing more on potential new contributors by
describing what KWin is and how to reach our team. E.g as a nice small
document readable on git project hosting sides.

The information in the readme is mostly taken from
https://community.kde.org/KWin/Mission_Statement

Diff Detail

Repository
R108 KWin
Branch
readme
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 6247
Build 6265: arc lint + arc unit
graesslin created this revision.Dec 21 2018, 4:48 PM
Restricted Application added a project: KWin. · View Herald TranscriptDec 21 2018, 4:48 PM
Restricted Application added a subscriber: kwin. · View Herald Transcript
graesslin requested review of this revision.Dec 21 2018, 4:48 PM
zzag added a subscriber: zzag.Dec 21 2018, 6:44 PM
zzag added inline comments.
README.md
3

KWin is an easy to use, but flexible, composited Window Manger for Xorg windowing systems on Linux.

There's a typo: manger. Also, it doesn't mention that KWin is also a Wayland compositor. :-)

graesslin added inline comments.Dec 21 2018, 7:31 PM
README.md
3

Argh, that's one of the most often spelling mistakes I do.

Xorg windowing systems includes X11 and Wayland. I think I'll put that in parentheses.

graesslin updated this revision to Diff 47980.Dec 21 2018, 7:46 PM
  • Fix typo
  • added Wayland and X11
zzag accepted this revision.Dec 21 2018, 7:47 PM
This revision is now accepted and ready to land.Dec 21 2018, 7:47 PM
Closed by commit R108:96496a8608db: Add a new markdown README (authored by graesslin). · Explain WhyDec 22 2018, 7:59 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
DMREADME (207 lines)
AMREADME.md (48 lines)

Diff 47972

View Options

README

Loading...
View Options

README.md

Loading...