summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b96319e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+
+ Filelight - a pie-chart diskspace viewer
+
+
+Filelight allows you to understand how your diskspace is being used by
+graphically representating your filesystem as a set of concentric
+segmented-rings.
+
+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.
+
+
+Usage Tips
+------------
+
+* 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
+* 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:
+
+ $ filelight /home/mxcl
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to filelight (TDE), you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/weblate
+
+
+Translations status
+---------------------
+
+### messages
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/filelight/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/filelight/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/filelight-desktop-files/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/filelight-desktop-files/)