summaryrefslogtreecommitdiff
path: root/system/rover/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/rover/README')
-rw-r--r--system/rover/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/system/rover/README b/system/rover/README
new file mode 100644
index 0000000000..8789dd1ff2
--- /dev/null
+++ b/system/rover/README
@@ -0,0 +1,21 @@
+Rover is a file browser for the terminal.
+
+The main goal is to provide a faster way to explore a file system from
+the terminal, compared to what's possible by using cd, ls, etc. Rover
+has vi-like key bindings for navigation and can open files in $PAGER
+and $EDITOR. Basic file system operations are also implemented Rover
+is designed to be simple, fast and portable.
+
+CUSTOMIZATION
+-------------
+To customize rover edit config.h in the source tarball and
+place it in the config directory before running the script.
+
+Example:
+
+$ cd rover-0.4.0
+$ vi config.h
+[make customizations]
+$ cp -a config.h ../config/
+$ cd ..
+# ./rover.SlackBuild \ No newline at end of file