about summary refs log tree commit diff stats
path: root/AUTHORS
diff options
context:
space:
mode:
Diffstat (limited to 'AUTHORS')
0 files changed, 0 insertions, 0 deletions
 

generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-11-22 19:38:52 +0000


 


:18:16 +0100
committer  hut <hut@lavabit.com>  2010-03-12 02:18:16 +0100

HACKING: updated' href='/akspecs/ranger/commit/HACKING?h=v1.4.3&id=290286314c4c349d3ffef5e947d66e48142311fd'>29028631 ^

f8f6f7f9 ^


















3ee05c16 ^

29028631 ^

f8f6f7f9 ^

f8f6f7f9 ^


29028631 ^



3ee05c16 ^


f8f6f7f9 ^







29028631 ^

f8f6f7f9 ^










f8f6f7f9 ^













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





















                                                                          
                      

                                                                       
                                                            

















                                                            
                                    
                           
 

                                                                      


                                                                              

                            






                                                                 
                                                                       









                                                                      










                          
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.


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.


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 <self> is a "SettingsAware" object.

* Changing commands, adding aliases:
ranger/defaults/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 ~/.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: Milestones
* Y: Stable versions
* Z: Experimental versions