aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index c1d0b7d..0d6aebe 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
# remove-old-kernels
-kernel removal tool for Mageia
+Old kernel removal tool for Mageia
+Remove old kernels safely and cleanly using urpme.
+
+Once installed it may be left to do it's job without user intervention.
+
+It is run by cron.weekly to retain a minimum number of installed kernels
+of each flavour. (Default is three)
+This may be adjusted or disabled using simple command line options if desired.
+
+There is also an advanced mode.
+
+It may also be run manually in interactive mode from the desktop menu,
+under Tools -> System tools.
+
+Running as normal user from the command line will display the current status
+of installed kernels but will not allow removal.
+
+For more information see: 'man remove-old-kernels' or 'man rok' in a terminal.