summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
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
id='n116' href='#n116'>116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161