Improve README documentation
ClosedPublic

Authored by ngraham on Jun 23 2019, 10:30 AM.

Details

Summary

Previously, README contained nothing but a link to userbase. A separate HACKING.md
file had non-technical developer documentation, but nothing technical to guide
people in the right direction.

This patch consolidates all information in the README file and adds technical
information about how to develop Dolphin.

BUG: 408967

Test Plan

Just read it :)

Diff Detail

Repository
R318 Dolphin
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
ngraham created this revision.Jun 23 2019, 10:30 AM
Restricted Application added a project: Dolphin. · View Herald TranscriptJun 23 2019, 10:30 AM
Restricted Application added a subscriber: kfm-devel. · View Herald Transcript
ngraham requested review of this revision.Jun 23 2019, 10:30 AM
yurchor accepted this revision.Jun 23 2019, 10:49 AM
yurchor added a subscriber: yurchor.
yurchor added inline comments.
README
3

It can be more user-friendly with https://userbase.kde.org/Special:myLanguage/Dolphin

34

Typo: He is developer -> He is a developer

This revision is now accepted and ready to land.Jun 23 2019, 10:49 AM
ngraham updated this revision to Diff 60447.Jun 23 2019, 10:56 AM

Fix error and improve userbase link

ngraham marked 2 inline comments as done.Jun 23 2019, 10:56 AM
This revision was automatically updated to reflect the committed changes.