Add man page, README, INSTALL, generate index.html.

[adu.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..5648ac5
--- /dev/null
+++ b/README
@@ -0,0 +1,10 @@
+adu creates a database containing disk usage statistics of a given
+directory. It allows to query that database to quickly retrieve usage
+patterns of subdirectories and/or files owned by a given user.
+
+Four different output modes are available: global list, global summary,
+user list, user summary. The format of the output may be customized
+via format strings.
+
+There's an interactive mode which allows to quickly launch many queries
+on the same database using different modes and different output files.