Update developer manual with new macOS packaging instructions
[privoxy.git] / doc / webserver / developer-manual / introduction.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >Introduction</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 REL="HOME"
10 TITLE="Privoxy Developer Manual"
11 HREF="index.html"><LINK
12 REL="PREVIOUS"
13 TITLE="Privoxy Developer Manual"
14 HREF="index.html"><LINK
15 REL="NEXT"
16 TITLE="The Git Repository"
17 HREF="git.html"><LINK
18 REL="STYLESHEET"
19 TYPE="text/css"
20 HREF="../p_doc.css"><META
21 HTTP-EQUIV="Content-Type"
22 CONTENT="text/html;
23 charset=ISO-8859-1"></HEAD
24 ><BODY
25 CLASS="SECT1"
26 BGCOLOR="#EEEEEE"
27 TEXT="#000000"
28 LINK="#0000FF"
29 VLINK="#840084"
30 ALINK="#0000FF"
31 ><DIV
32 CLASS="NAVHEADER"
33 ><TABLE
34 SUMMARY="Header navigation table"
35 WIDTH="100%"
36 BORDER="0"
37 CELLPADDING="0"
38 CELLSPACING="0"
39 ><TR
40 ><TH
41 COLSPAN="3"
42 ALIGN="center"
43 >Privoxy Developer Manual</TH
44 ></TR
45 ><TR
46 ><TD
47 WIDTH="10%"
48 ALIGN="left"
49 VALIGN="bottom"
50 ><A
51 HREF="index.html"
52 ACCESSKEY="P"
53 >Prev</A
54 ></TD
55 ><TD
56 WIDTH="80%"
57 ALIGN="center"
58 VALIGN="bottom"
59 ></TD
60 ><TD
61 WIDTH="10%"
62 ALIGN="right"
63 VALIGN="bottom"
64 ><A
65 HREF="git.html"
66 ACCESSKEY="N"
67 >Next</A
68 ></TD
69 ></TR
70 ></TABLE
71 ><HR
72 ALIGN="LEFT"
73 WIDTH="100%"></DIV
74 ><DIV
75 CLASS="SECT1"
76 ><H1
77 CLASS="SECT1"
78 ><A
79 NAME="INTRODUCTION"
80 >1. Introduction</A
81 ></H1
82 ><P
83 >     <SPAN
84 CLASS="APPLICATION"
85 >Privoxy</SPAN
86 >, as an heir to
87      <SPAN
88 CLASS="APPLICATION"
89 >Junkbuster</SPAN
90 >, is a <A
91 HREF="https://www.privoxy.org/user-manual/copyright.html"
92 TARGET="_top"
93 >Free Software</A
94 > project.
95      As such, <SPAN
96 CLASS="APPLICATION"
97 >Privoxy</SPAN
98 > development is potentially open
99      to anyone who has the time, knowledge, and desire to contribute
100      in any capacity. Our goals are simply to continue the mission,
101      to improve <SPAN
102 CLASS="APPLICATION"
103 >Privoxy</SPAN
104 >, and
105      to make it available to as wide an audience as possible.
106     </P
107 ><P
108 >     One does not have to be a programmer to contribute. Packaging, testing,
109      documenting and porting, are all important jobs as well.
110     </P
111 ><DIV
112 CLASS="SECT2"
113 ><H2
114 CLASS="SECT2"
115 ><A
116 NAME="QUICKSTART"
117 >1.1. Quickstart to Privoxy Development</A
118 ></H2
119 ><P
120 >    The first step is to join the <A
121 HREF="https://lists.privoxy.org/mailman/listinfo/privoxy-devel"
122 TARGET="_top"
123 >privoxy-devel mailing list</A
124 >.
125     You can submit your ideas or, even better, patches.
126     Patches can also be submitted to the
127     <A
128 HREF="https://sourceforge.net/p/ijbswa/patches/"
129 TARGET="_top"
130 >Sourceforge patch tracker</A
131 >.
132    </P
133 ><P
134 >     You will also need to have a git package installed,
135      in order to access the git repository.
136      Having the GNU build tools is also going to be important (particularly,
137      autoconf and gmake).
138     </P
139 ><P
140 >      For the time being (read, this section is under construction), you can
141       also refer to the extensive comments in the source code. In fact,
142       reading the code is recommended in any case.
143     </P
144 ></DIV
145 ></DIV
146 ><DIV
147 CLASS="NAVFOOTER"
148 ><HR
149 ALIGN="LEFT"
150 WIDTH="100%"><TABLE
151 SUMMARY="Footer navigation table"
152 WIDTH="100%"
153 BORDER="0"
154 CELLPADDING="0"
155 CELLSPACING="0"
156 ><TR
157 ><TD
158 WIDTH="33%"
159 ALIGN="left"
160 VALIGN="top"
161 ><A
162 HREF="index.html"
163 ACCESSKEY="P"
164 >Prev</A
165 ></TD
166 ><TD
167 WIDTH="34%"
168 ALIGN="center"
169 VALIGN="top"
170 ><A
171 HREF="index.html"
172 ACCESSKEY="H"
173 >Home</A
174 ></TD
175 ><TD
176 WIDTH="33%"
177 ALIGN="right"
178 VALIGN="top"
179 ><A
180 HREF="git.html"
181 ACCESSKEY="N"
182 >Next</A
183 ></TD
184 ></TR
185 ><TR
186 ><TD
187 WIDTH="33%"
188 ALIGN="left"
189 VALIGN="top"
190 >Privoxy Developer Manual</TD
191 ><TD
192 WIDTH="34%"
193 ALIGN="center"
194 VALIGN="top"
195 >&nbsp;</TD
196 ><TD
197 WIDTH="33%"
198 ALIGN="right"
199 VALIGN="top"
200 >The Git Repository</TD
201 ></TR
202 ></TABLE
203 ></DIV
204 ></BODY
205 ></HTML
206 >