about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2010-01-14 02:53:59 +0100
committerhut <hut@lavabit.com>2010-01-14 02:53:59 +0100
commit306c76d8fbe649a0bf6c34a1fc446af6d2ec201b (patch)
treeca80982408bee7b918c6162531e8b4cb48405b8a /README
parentb6aed5ef1070490d2acdd76a7da767c068f4bea9 (diff)
downloadranger-306c76d8fbe649a0bf6c34a1fc446af6d2ec201b.tar.gz
readme: added part "customizing ranger"
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 16 insertions, 0 deletions
diff --git a/README b/README
index 96163a01..f82c8d5b 100644
--- a/README
+++ b/README
@@ -68,6 +68,22 @@ open files from the shell:
     ranger blabla.pdf
 
 
+== Customizing Ranger
+
+The file ranger/defaults/options.py contains most of the options.
+apps.py defines how files are run, keys.py defines keybindings.
+
+The files in ranger/defaults/ can be copied into ~/.ranger/ for per-user
+modifications.  Colorschemes can be placed in ~/.ranger/colorschemes.
+
+The options.py defines the import path of "apps", "keys" and the
+colorscheme.  To use the files you placed in ~/.ranger/, you may need
+to make this changes in the options.py:
+
+"from ranger.defaults import apps, keys" => "from . import apps, keys"
+"from ranger import colorschemes" => "from . import colorschemes"
+
+
 == Guidelines for developers:
 
 Tabs for indentation, spaces for tables and such