summaryrefslogtreecommitdiff
path: root/documentation/develop.html
blob: c888de5e19199e4e6bde8d8879f6302c6df00280 (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
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
        "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>NetSurf | Developer Documentation</title>
<link rel="stylesheet" type="text/css" href="/netsurf.css">
<link rel="icon" type="image/png" href="/webimages/favicon.png">
</head>

<body>
<p class="banner"><a href="/"><img src="/netsurf.png" alt="NetSurf"></a></p>

<div class="navigation">
<div class="navsection">
<ul>
<li><a href="/about/">About NetSurf</a></li>
<li><a href="/downloads/">Downloads</a></li>
<li><a href="/documentation/">Documentation</a>
<ul>
<li><a href="/documentation/info">User info</a></li>
<li><a href="/documentation/guide">User guide</a></li>
<li><a href="/documentation/progress">Project progress</a></li>
<li><a href="/documentation/develop">Developer info</a></li>
</ul>
</li>
<li><a href="/developers/">Development area</a></li>
<li><a href="/webmasters/">Webmaster area</a></li>
<li><a href="/contact/">Contact</a></li>
</ul>
</div>

<div class="navsection">
<ul class="languages">
<!--<li><a href="index.de">Deutsch</a></li>-->
<li>English</li>
<!--<li><a href="index.fr">Franšais</a></li>-->
<!--<li><a href="index.nl">Nederlands</a></li>-->
</ul>
</div>

<div class="navsection">
<ul class="sitelinks">
<li><a href="http://wiki.netsurf-browser.org/">Development wiki</a></li>
<li><a href="http://source.netsurf-browser.org/">Git repository viewer</a></li>
<li><a href="http://ci.netsurf-browser.org/">Continuous Integration</a></li>
<li><a href="http://bugs.netsurf-browser.org/">Bug report system</a></li>
</ul>
</div>

</div>

<div class="content">

<p class="breadcrumbs"><a href="/">Home</a><a href="/documentation/">Documentation</a> ╗ Developer information</p>

<h1>Developer Information</h1>

<p>This document contains various information for developers or anyone interested in contributing to NetSurf.</p>

<ul>
<li><a href="develop#SourceControl">Source control</a></li>
<li><a href="develop#Compiling">Compiling</a></li>
<li><a href="develop#SourceDocumentation">Source documentation</a></li>
<li><a href="develop#Communication">Communication</a></li>
<li><a href="develop#Translations">Translations</a></li>
</ul>

<p class="updated">Last updated 11 November 2007</p>

<h2 id="SourceControl">Source control</h2>

<p>The source is kept in a Git repository. To check the source out use the command:</p>

<p><code>$ <strong>git clone git://git.netsurf-browser.org/netsurf.git</strong></code></p>

<p>You can also browse the source via the <a href="http://source.netsurf-browser.org/netsurf.git/">web interface</a>.</p>

<p>Recent changes can be seen on the <a href="/developers/">development page</a>. An an <a href="http://cia.navi.cx/stats/project/NetSurf/.rss">RSS feed</a> of recent changes is also provided by <a href="http://cia.navi.cx/stats/project/NetSurf/">CIA</a>. All checkins are reported on the <a href="/contact/#MailingLists">Commits mailing list</a>.</p>

<p>Contact <a href="mailto:dsilvers@netsurf-browser.org">Daniel Silverstone</a> to get write access to the Git repository.  We also accept pull requests from places such as <em>github</em>.</p>


<h2 id="Compiling">Compiling</h2>

<p>The recommended compilers are GCC or Clang.  Guides to <a href="http://source.netsurf-browser.org/netsurf.git/tree/Docs">building NetSurf</a> for various platforms are available in the source tree.</p>

<p>The <a href="http://ci.netsurf-browser.org/">autobuilder</a> compiles every change pushed to our Git repository.  It also runs test suites and other features automatically.</p>

<p>A debug version of NetSurf can be built. This is command-line only and does not include any GUI code. It runs natively on Linux so can be debugged and checked using gdb, efence, valgrind, etc.</p>

<h3>Dependencies</h3>

<p>NetSurf requires a number of additional libraries to build.  Consult the documents in the <a href="http://source.netsurf-browser.org/netsurf.git/tree/Docs">Docs</a> directory of NetSurf's source tree for more info.</p>


<h2 id="SourceDocumentation">Source documentation</h2>

<p>See the <a href="http://source.netsurf-browser.org/netsurf.git/tree/Docs">Docs</a> directory for source code documentation. Our pictorial <a href="/developers/StyleGuide.pdf">Style Guide</a> (single-page PDF) shows our code style.</p>


<h2 id="Communication">Communication</h2>

<p>The main method of communication between the developers is the <a href="/contact/#IRCChannel"><code>#netsurf</code> <abbr title="Internet Relay Chat">IRC</abbr> channel</a>.</p>

<p>The <a href="/contact/#MailingLists">developers' mailing list</a> is also used for less transient communication.</p>


<h2 id="Translations">Translations</h2>

<p>Translations of NetSurf to other languages are welcome. No programming knowledge is required, just the ability to use a template editor and a text editor. Please see the <a href="translations">translations page</a> for more information.</p>


<div class="footer">
<p>Copyright 2003 - 2012 The NetSurf Developers</p>
</div>

</div>


<form method="get" action="http://www.google.co.uk/search">
<div class="searchbox">
<input type="hidden" name="q" value="site:netsurf-browser.org">
<input type="text" name="q" maxlength="255"><br>
<input type="submit" value="Search" name="btnG">
</div>
</form>

</body>
</html>