Updating changelist
[gonvert] / support / doc / README
1 Description: 
2 ===========
3 gonvert is a conversion utility that allows conversion between many units 
4 like CGS, Ancient, Imperial with many categories like length, mass, numbers, 
5 etc. All units converted values shown at once as you type. Easy to add/change 
6 your own units. Written in Python,pygtk,libgade. 
7
8
9 Goals:
10 =====
11 The goal when making gonvert was to have the most complete and easy to use 
12 unit conversion utility. It is still growing as I find new units.
13
14
15 Contact:
16 ========
17  anthony@unihedron.com 
18
19
20 INSTALLATION:
21 =============
22 See INSTALL for installation notes
23
24
25 USAGE:
26 ======
27 - Start the program by typing "gonvert".
28 - Select the category of units that you want to convert.
29 - Select the unit that want to enter a value for.
30 - Type the value.
31 - The top two rows on the right side are temporary locations that scroll 
32   through each unit you select. You can use this area to convert
33   between one unit and another without scrolling through the entire list
34   units.
35
36
37 Other features:
38 ===============
39 - You can sort Units and Value columns by clicking on the column name.
40 - You can print (to STDOUT) out all the units by selecting Tools>Write_Units
41 - You can find units by typing the name of the desired unit at the bottom
42   input field then pressing the Find butonn or hitting enter.
43   The number of units found that match the desired string is displayed
44   in the label at the bottom right. F6 key also acts as the Find button.
45 - previously selected categories and units are saved to ~/.gonvert/ directory
46
47
48
49 Warranty:
50 =========
51 The usual disclaimer, I am not responsible for any damages this program may
52 cause. Use at your own risk. See COPYING for license.
53
54
55 Making additions and changes:
56 =============================
57 If you make corrections or additions to the program, please e-mail me so that I
58 can incorporate them into the source (with credit to your name of course).
59 Please keep in mind that this project is GPL (see COPYING file) so do not use
60 copyrighted material in your changes/additions to the unit descriptions that you
61 submit to me.
62
63 Make sure that all standard calculations using the m() function have floating
64 point arguments. In other words use at least one number in the formula with a
65 decimal point to force floating point numbers:
66  (m,5/2)        #this is bad (the result will be 2, not 2.5)
67  (m,5.0/2)      #this forces float (good, the result will be 2.5)
68
69
70 Without knowing Python:
71 You can alter the code without knowing much about Python just be reviewing the
72 method that the units definitions were written. Be careful to include the same
73 number of starting and ending brackets, also be careful of the commas.
74
75 If you want to use mathematical functions like pi etc you can see what other
76 functions there are as follows:
77
78 # python
79 >>>from math import *
80 >>>dir()
81 ['__builtins__', '__doc__', '__name__', 'acos', 'asin', 'atan', 'atan2', 'ceil',
82 'cos', 'cosh',  'e', 'exp', 'fabs', 'floor', 'fmod', 'frexp', 'hypot', 'ldexp',
83 'log', 'log10', 'modf', 'pi', 'pow', 'sin', 'sinh', 'sqrt', 'tan',  'tanh']
84
85
86 A good book for learning Python is the O'Reilly "Learning Python" book by 
87 Mark Lutz and David Ascher.
88
89
90
91
92
93
94
95
96 Location of installed gonvert software is put into directories suggested by 
97 then manpage hier (man hier).
98
99  /usr/bin
100         gonvert program (this is the source)
101
102  /usr/doc
103         gonvert documentation files.
104
105  /usr/lib
106         Files associated with gonvert like the glade file and the pixmaps.
107
108  /usr/man
109         gonvert Man page (when one is written)
110
111  ~/.gonvert
112         user configuration files associated with gonvert.
113
114
115