annotate doc/README @ 1770:4779a3d891a1

trim some spaces
author corvid <corvid@lavabit.com>
date Wed, 24 Nov 2010 19:26:45 +0000
parents 20ffd8b339cc
children
rev   line source
1252
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
1 README: Last update Jul 2009
0
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
2
1252
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
3 These documents cover dillo's internals.
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
4 For user help, see http://www.dillo.org/dillo2-help.html
0
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
5
1252
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
6 --------------------------------------------------------------------------
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
7
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
8 These documents need a review.
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
9 *.txt were current with Dillo1, but many have since become more or
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
10 less out-of-date.
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
11 *.doc are doxygen source for the Dillo Widget (dw) component, and
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
12 were written for Dillo2.
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
13
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
14 They will give you an overview of what's going on, but take them
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
15 with a pinch of salt.
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
16
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
17 Of course I'd like to have *.txt as doxygen files too!
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
18 If somebody wants to make this conversion, please let me know
0
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
19 to assign higher priority to updating these docs.
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
20
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
21 --
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
22 Jorge.-
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
23
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
24 --------------------------------------------------------------------------
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
25 FILE DESCRIPTION STATE
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
26 --------------------------------------------------------------------------
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
27 NC_design.txt Naming&Coding design (Be sure to Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
28 read it before any other doc)
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
29 Dillo.txt General overview of the program Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
30 IO.txt Extensive introduction Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
31 Cache.txt Informative description Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
32 Images.txt Image handling and processing Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
33 HtmlParser.txt A versatile parser Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
34 Dw.txt The New Dillo Widget (Overview) Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
35 Imgbuf.txt Image buffers Pending
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
36 Selection.txt Selections, and link activation Current (?)
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
37 Cookies.txt Explains how to enable cookies Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
38 Dpid.txt Dillo plugin daemon Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
39 --------------------------------------------------------------------------
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
40
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
41
1252
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
42 * BTW, there's a small program (srch) within the src/ dir. It searches
0
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
43 tokens within the whole code (*.[ch]). It has proven very useful.
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
44 Ex: ./srch a_Image_write
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
45 ./srch todo:
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
46
1252
20ffd8b339cc update docs a bit
corvid <corvid@lavabit.com>
parents: 395
diff changeset
47 * Please submit your patches with 'hg diff'.
0
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
48
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
49
1770
4779a3d891a1 trim some spaces
corvid <corvid@lavabit.com>
parents: 1252
diff changeset
50 Happy coding!
0
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
51 --Jcid