summaryrefslogtreecommitdiff
path: root/plugins/!NotAdopted/VypressChat/docs/README
blob: 0a0cf965ee30259e6980bbfb534e54f49318585e (plain)
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
Readme skeleton (to be written)
$Id: README,v 1.1 2005/03/02 18:58:34 bobas Exp $

CONTENTS
*********************************
1. WHAT IS IT
2. USAGE
3. COMPILING FROM SOURCE
4. CODING
5. FAQ



1. WHAT IS IT
=================================
1.1. Features
	TODO

1.2. Requirements
	TODO

1.3. Limitations
	TODO

1.4. Authors
	TODO

2. USAGE
=================================
2.1. Settings
	TODO

2.2. Contacts
	TODO

2.3. Updating nickname or guid(unique identifier) for a contact
	TODO

3. COMPILING FROM SOURCE
=================================
3.1. Requirements
	You will need a mingw/cygwin instalation with basic unix
	tools (like ls, rm) and gcc, make, binutils. Maybe something else.
	Just try to compile and watch for errors :)

3.2. Gow to build it
	TODO

3.3. Anonymous access to CVS repository
	TODO

4. CODING
=================================
4.1. Code layout
	Tabs are 8 chars and max code line length is 100 chars.

4.2. Charset stuff
	Everything inside plugins' structs and between the calls is done
	in utf-8, sans some exceptions (strings from/to network and Windows).
	
	Strings that are sent to network should first be reprocessed
	by util_utf2vqp(), to translate them to fitting encoding for the
	receiving host. The same is with incoming network strings
	- use util_vqp2utf().

	Use 'W Win32 calls to send/recv unicode strings within Win32 API.
	util_utf2ucs() and util_ucs2uni() routines are provided for
	conversion from/to wchar_t * to char * and back.

4.3. Basic source overview
	TODO

4.4. Vypress Chat/quickChat protocol
	TODO

5. FAQ
	TODO

EOF