summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2019-11-22 14:06:49 +0100
committerMichele Calgaro <michele.calgaro@yahoo.it>2019-11-27 23:07:06 +0900
commit9a2ffe6c188b2049f76c8cf608a3b530a6c23d28 (patch)
tree573b1e41d549851839e381b63e4707776992d98c /README
parente2e116f8adc3a7f732ac70a3c795deaedf8b3f4c (diff)
downloadfilelight-9a2ffe6c188b2049f76c8cf608a3b530a6c23d28.tar.gz
filelight-9a2ffe6c188b2049f76c8cf608a3b530a6c23d28.zip
Drop automake build support.
Add basic cmake build instructions. Add a man page taken from Debian packaging. Delete empty file NEWS. Rework on the README, INSTALL and help page. Signed-off-by: gregory guy <gregory-tde@laposte.net> (cherry picked from commit 8a5ab0cb65d78b80d7b9654077e24b8078b840df)
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 17 insertions, 24 deletions
diff --git a/README b/README
index c624052..ff12489 100644
--- a/README
+++ b/README
@@ -1,20 +1,16 @@
- Filelight README
-==================
+ Filelight - a pie-chart diskspace viewer
+
-Filelight allows you to understand exactly where your diskspace is being used by
+Filelight allows you to understand how your diskspace is being used by
graphically representating your filesystem as a set of concentric
segmented-rings.
-README last updated with respect to 1.0
---------------------------------------------------------------------------------
+It is like a pie-chart indeed, but the segments nest allowing you to see
+both which directories take up all your space as well as which
+directories and files inside those directories are the real culprits.
- Dependencies
-==============
-
-Filelight depends on KDElibs >= 3.2 and therefore Qt >= 3.2.
-
Usage Tips
============
@@ -22,28 +18,25 @@ Filelight depends on KDElibs >= 3.2 and therefore Qt >= 3.2.
* Click on directories to center the view there
* Click on files to launch the application associated with them
* Middle click to open files/directories with Konqueror
-* Right click on the central white circle to manipulate the base directory
+* Right click on the central white circle to manipulate the base
+ directory
* Increase the window size to see more detail
* Hover over segments to find out more information
* Available as a view-KPart in Konqueror
-* You can specify a directory to scan on startup from the command line, eg:
+* You can specify a directory to scan on startup from the command line,
+ eg:
$ filelight /home/mxcl
- Install
-=========
-
-See the accompanying file; INSTALL.
+CONTRIBUTING
+==============
- Bugs
-======
-
-There are less bugs everyday! Please report bugs to filelight@methylblue.com
---------------------------------------------------------------------------------
-
+If you wish to contribute to filelight (TDE), you might do so:
-I hope you enjoy using Filelight!
+- TDE Gitea Workspace (TGW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/gitea
-Max Howell <max.howell@methylblue.com>
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/weblate