Improve package documentation
ClosedPublic

Authored by filipf on Nov 19 2019, 9:03 PM.

Details

Summary

The old readme file was just 4 outdated lines on how to compile the package..

I've now tried to add all the crucial info and write the file in Markdown.

CC-BUG: 414289

Test Plan


Diff Detail

Repository
R123 SDDM Configuration Panel (KCM)
Branch
better-documentation (branched from master)
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 19042
Build 19060: arc lint + arc unit
filipf created this revision.Nov 19 2019, 9:03 PM
Restricted Application added a project: Plasma. · View Herald TranscriptNov 19 2019, 9:03 PM
Restricted Application added a subscriber: plasma-devel. · View Herald Transcript
filipf requested review of this revision.Nov 19 2019, 9:03 PM
filipf edited the test plan for this revision. (Show Details)Nov 19 2019, 9:04 PM
filipf added reviewers: Plasma, VDG, ngraham.
filipf edited the summary of this revision. (Show Details)
ngraham accepted this revision.Nov 19 2019, 10:04 PM

LGTM.

This revision is now accepted and ready to land.Nov 19 2019, 10:04 PM

Maybe I shouldn't list all those dependencies like that. The list would probably get outdated soon and maybe the deps can be listed more abstractly so there's fewer lines.

The list would probably get outdated soon and maybe the deps can be listed more abstractly so there's fewer lines.

Yeah. Also this looks like the output of running cmake anyway, so I don't see what we gain by writing it in another place.

filipf updated this revision to Diff 70082.Nov 20 2019, 9:24 PM

simpler dependencies list

davidedmundson accepted this revision.Nov 21 2019, 3:15 PM
filipf updated this revision to Diff 70130.Nov 21 2019, 10:23 PM

minor indentation fix

This revision was automatically updated to reflect the committed changes.