From d176ad91fb02fb5bdc50fe85ee8b90105ba5ff90 Mon Sep 17 00:00:00 2001 From: hut Date: Tue, 4 Jan 2011 01:51:25 +0100 Subject: Moved HACKING and TODO to doc/ --- HACKING | 95 ----------------------------------------------------------------- 1 file changed, 95 deletions(-) delete mode 100644 HACKING (limited to 'HACKING') diff --git a/HACKING b/HACKING deleted file mode 100644 index dd384758..00000000 --- a/HACKING +++ /dev/null @@ -1,95 +0,0 @@ -Guidelines on Code Modification -=============================== - -Coding Style ------------- - -* Use syntax compatible to both python 2.6 and 3.1. -* Use docstrings with pydoc in mind -* Follow the style guide for python code: - http://www.python.org/dev/peps/pep-0008/ -* Although this guide suggests otherwise, tabs are used for indentation - of code and docstrings. In other documents (readme, etc), use spaces. -* Test the code with unit tests where it makes sense - - -Patches -------- - -Send patches, created with "git format-patch", to the email adress - - romanz@lavabit.com - -If you plan to do major changes, or many changes over time, I encourage -you to create a fork on GitHub, Gitorious or any other site. - - -Starting Points ---------------- - -Good places to read about ranger internals are: -ranger/core/actions.py -ranger/core/environment.py -ranger/fsobject/fsobject.py - -About the UI: -ranger/gui/widgets/browsercolumn.py -ranger/gui/widgets/browserview.py -ranger/gui/defaultui.py - - -Common Changes --------------- - -* Change which files are previewed in the auto preview: -In ranger/gui/widget/browsercolumn.py -the constant PREVIEW_BLACKLIST - -* Adding options: -In ranger/defaults/options.py -add the default value, like: my_option = True -In ranger/shared/settings.py -add the name of your option to the constant ALLOWED_SETTINGS - -The setting is now accessible at self.settings.my_option, -assuming is a "SettingsAware" object. - -* Changing commands, adding aliases: -ranger/defaults/commands.py -or ~/.config/ranger/commands.py - -* Adding colorschemes: -Copy ranger/colorschemes/default.py to ranger/colorschemes/myscheme.py -and modify it according to your needs. Alternatively, mimic the jungle -colorscheme. It subclasses the default scheme and just modifies a few things. -In ranger/defaults/options.py (or ~/.config/ranger/options.py), change - colorscheme = 'default' -to: colorscheme = 'myscheme' - -* Change which files are considered to be "hidden": -In ranger/defaults/options.py -change the hidden_filter regular expression. - -* Change the key map: -Modify ranger/defaults/keys.py. This should be self-explanatory. -Check out ranger/core/actions.py for the most common actions, of course -you can also use your own functions. - -* Change the file type => application associations: -In ranger/defaults/apps.py -modify the method app_default. -The variable "f" is a filesystem-object with attributes like mimetype, -extension, etc. For a full list, check ranger/fsobject/fsobject.py - -* Change the file extension => mime type associations: -Modify ranger/data/mime.types - - -Version Numbering ------------------ - -X.Y.Z, where: - -* X: Major version, milestone -* Y: Minor version, even number => stable version -* Z: Revision, may be omitted if zero -- cgit 1.4.1-2-gfad0 class='oid'>1168570 ^ 
37be25f ^

1168570 ^







a6f47c0 ^



1168570 ^


6c05076 ^

1168570 ^




a6f47c0 ^

1168570 ^










505c5d8 ^

1168570 ^





505c5d8 ^

1168570 ^





















505c5d8 ^



37be25f ^


505c5d8 ^

37be25f ^


4f0847b ^

37be25f ^


505c5d8 ^


505c5d8 ^


37be25f ^



505c5d8 ^

a6f47c0 ^


dec003b ^

1168570 ^

505c5d8 ^

f4eb1c7 ^

1168570 ^









df1d1ef ^

1168570 ^





dec003b ^





1168570 ^

dec003b ^


a6f47c0 ^


dec003b ^

1168570 ^

dec003b ^

f4eb1c7 ^

1168570 ^













37be25f ^

37bf8b0 ^

37be25f ^





37bf8b0 ^

1168570 ^




37be25f ^

37bf8b0 ^

37be25f ^







37bf8b0 ^

1168570 ^



a6f47c0 ^


1168570 ^

a6f47c0 ^

1168570 ^










711012e ^

1168570 ^


1168570 ^

2b0d4a5 ^

1168570 ^




2b0d4a5 ^



1168570 ^







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
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
162
163
164
165
166
167
168
169

170

171
172

173

174

175
176
177
178

179
180
181

182
183
184
185
186
187
188