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
que' href='/akspecs/ranger/commit/test/tc_ext.py?h=v1.4.2&id=5a087b1667813ad75f84d0cfbe38babd428bf5d6'>5a087b16 ^
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123