Skip to content

Commit 2da47c3

Browse files
redstrateMéven Car
authored and
Méven Car
committed
Improve README, add screenshot
I didn't touch any of the content - save for removing that weird header formatting and removing the soon-to-be-obsolete UserBase link. A screenshot has been added.
1 parent 5365be0 commit 2da47c3

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
1-
User Documentation
2-
==================
3-
See https://userbase.kde.org/Special:myLanguage/Dolphin
1+
# Dolphin
42

3+
Dolphin is KDE's file manager that lets you navigate and browse the contents of your hard drives, USB sticks, SD cards, and more. Creating, moving, or deleting files and folders is simple and fast. See more information [on Dolphin's homepage](https://apps.kde.org/dolphin/).
54

5+
![Screenshot](https://cdn.kde.org/screenshots/dolphin/dolphin.png)
66

7-
Development Information
8-
=======================
9-
Dolphin's source code can be found at https://invent.kde.org/system/dolphin/
7+
## User Documentation
108

11-
To build Dolphin from source, see https://community.kde.org/Get_Involved/development#Applications
9+
See https://userbase.kde.org/Special:myLanguage/Dolphin.
1210

13-
To submit a patch to Dolphin, use https://invent.kde.org/system/dolphin/-/merge_requests/.
11+
## Contributing
1412

13+
Like other projects in the KDE ecosystem, contributions are welcome from all. This repository is managed in [KDE Invent](https://invent.kde.org/system/dolphin), our GitLab instance.
1514

15+
* Want to contribute code? See the [GitLab wiki page](https://community.kde.org/Infrastructure/GitLab) for a tutorial on how to send a merge request.
16+
* Reporting a bug? Please submit it on the [KDE Bugtracking System](https://bugs.kde.org/enter_bug.cgi?format=guided&product=dolphin). Please do not use the Issues
17+
tab to report bugs.
18+
* Is there a part of Dolphin that's not translated? See the [Getting Involved in Translation wiki page](https://community.kde.org/Get_Involved/translation) to see how
19+
you can help translate!
20+
21+
If you get stuck or need help with anything at all, head over to the [KDE New Contributors room](https://go.kde.org/matrix/#/#kde-welcome:kde.org) on Matrix. For questions about Dolphin, please ask in the [KDE File Management room](https://go.kde.org/matrix/#/#kde-fm:kde.org). See [Matrix](https://community.kde.org/Matrix) for more details.
22+
23+
## Development Philosophy
1624

17-
Development Philosophy
18-
======================
1925
Dolphin is a file manager focusing on usability. When reading the term Usability people often assume that the focus is on newbies and only basic features are offered. This is not the case; Dolphin is quite full-featured, but the features are carefully chosen so as to not impede any of the users in the target user groups.
2026

27+
### Target User Groups
2128

22-
Target User Groups
23-
------------------
2429
Focusing on usability means that features are discoverable and efficient to use. The feature set is defined indirectly by the target user group of Dolphin:
2530

2631
- **Lisa**: Lisa has been familiar with computers for 10 years. From her job, she has experience with Word, Excel and Outlook. At home she mainly uses the computer for browsing the web and writing e-mails. She requires a file manager for managing photos from the camera, documents she gets via e-mail, or PDFs she downloads with a browser. Lisa knows concepts like folders and a file hierarchy, but she is not familiar with the file hierarchy of Linux.
@@ -35,14 +40,12 @@ Not part of the target user group of Dolphin are Fred and Jeff:
3540

3641
This does not mean that Fred or Jeff cannot work with Dolphin. But there might be features and concepts of Dolphin that overburden Fred. Also Jeff might miss some features which are a must-have for his daily work. This is acceptable; there are other tools that cater specifically to their needs.
3742

43+
### Non-Intrusive Features
3844

39-
Non-Intrusive Features
40-
-----------------------
4145
Before a feature is added in Dolphin, check whether the feature is mandatory for the target user group. If this is not the case, then this does not mean that the feature cannot be added; first it must be clarified whether the feature might be non-intrusive, so that it adds value for users outside the primary target user group of Dolphin. The term "non-intrusive" is mainly related to the user interface. A feature that adds a lot of clutter to the main menu, context menus or toolbar might harm the target user group. In this case the feature should not be added.
4246

4347
A good example of a feature that is non-intrusive is the embedded terminal in Dolphin. It only requires one entry inside a sub-menu, but adds great value for Jeff, who is not part of the target user group.
4448

49+
### Options
4550

46-
Options
47-
-------
4851
Options are mandatory as the "average Joe" user does not exist. Still it is not the goal of Dolphin to offer options for all kind of things. Again the focus is on the possible needs of the target user group. Each additional option makes it harder finding other options, so the same rules for features are applied to options too.

0 commit comments

Comments
 (0)