summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README49
1 files changed, 49 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..c624052
--- /dev/null
+++ b/README
@@ -0,0 +1,49 @@
+
+ Filelight README
+==================
+
+Filelight allows you to understand exactly where 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
+--------------------------------------------------------------------------------
+
+
+ Dependencies
+==============
+
+Filelight depends on KDElibs >= 3.2 and therefore Qt >= 3.2.
+
+
+ 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
+
+
+ Install
+=========
+
+See the accompanying file; INSTALL.
+
+
+ Bugs
+======
+
+There are less bugs everyday! Please report bugs to [email protected]
+--------------------------------------------------------------------------------
+
+
+I hope you enjoy using Filelight!
+
+Max Howell <[email protected]>