-
Notifications
You must be signed in to change notification settings - Fork 0
/
developers.html
102 lines (95 loc) · 5.23 KB
/
developers.html
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
<html>
<head>
<title>SockIt · Developers</title>
<link href="tutorial.css" rel="stylesheet" type="text/css">
</head>
<body>
<div class='section'>
<center>
<h1>SockIt · Developers</h1>
<h3><a href="downloads.html">Download</a></h3>
<br/>
<br/>
<a href="index.html">Home</a> · <a href="tutorial.html">Quick Tutorial</a> · <a href="full_tutorial.html">Full Tutorial</a> · <a href="demos.html">Demos</a> · <a href="api_documentation.html">API</a> · <a href="html/index.html">Source Documentation</a> · <a href="developers.html">Developers</a>
</center>
<br/>
<h2>Overview</h2>
<div class="section">
<p>
To get familiar with the code, see the full <a href="html/index.html">source documentation</a>, or browse the code on GitHub.<br/><br/>
The structure of Firebreath forces the project directories to be structured a bit counter-intuitively, such that the SockIt source root is located in the <code>projects</code> directory of the firebreath source tree.
</p>
<p>
The build process is automated on Windows, Linux, and Mac, but each platform has a few basic dependencies.
</p>
</div>
<br/>
<h2>Getting the Source</h2>
<div class="section">
<p></p>
<ol>
<li>Install <a href="http://git-scm.com/">git</a> if you have not already done so, and if you are on Windows, add git to your <code>PATH</code> variable. For Mac, we recommend using homebrew to install git.</li>
<li>Clone the <code>firebreath-dev</code> branch. This project requires at least version 1.5, but in our experience building the plugin, the firebreath dev branch has been fairly stable.
<pre>git clone git://github.com/firebreath/FireBreath.git firebreath-dev</pre>
</li>
<li>
Make the <code>projects</code> directory.
<pre>mkdir firebreath-dev/projects</pre>
</li>
<li>
Clone the SockIt source as a new project, and <code>cd</code> into the project directory.
<pre>git clone [email protected]:sockit/sockit.git firebreath-dev/projects/sockit && cd firebreath-dev/projects/sockit</pre>
</li>
</ol>
</div>
<br/>
<h2>Building</h2>
<div class="section">
<h3>Linux</h3>
<ol>
<li>Install dependencies of Firebreath and SockIt.</li>
<pre>sudo apt-get install cmake libgtk2.0 g++</pre>
<li>Build for either 32-bit or 64-bit Linux by providing <code>64</code> or <code>32</code> for <code>platform</code>, respectively.
<pre>./build_linux.sh <platform></pre>
</li>
</ol>
<h3>Mac OSX</h3>
<ol>
<li>Install dependencies of Firebreath and SockIt. We recommend using <a href="http://mxcl.github.com/homebrew/">Homebrew</a> or <a href="http://www.macports.org/">MacPorts</a> to install <code>git</code>. Besides <code>git</code>, you will need <code>Xcode</code>, which you can obtain from Apple.</li>
<li>Build universal SockIt binaries for Mac by running <code>build_mac.sh</code>.</li>
</ol>
<h3>Windows</h3>
<ol>
<li>Install Visual Studio 2010 (Visual Studio 2005 and 2008 should also work, but are untested).</li>
<li>Add Visual Studio's <code>msbuild</code> and its dependencies to your path.</li>
<li>Run <code>build_win.bat</code>.</li>
</ol>
</div>
<br/>
<h2>Packaging</h2>
<div class="section">
<h3>Linux</h3>
<ol>
<li>Package SockIt for Chrome and Firefox on either 32-bit or 64-bit Linux by providing <code>64</code> or <code>32</code> for <code>platform</code>, respectively.
<pre>./pack_linux.sh <platform></pre>
</li>
<li>Binaries can be found in <code>bin/linux/</code>.</li>
</ol>
<h3>Mac</h3>
<ol>
<li>Package SockIt for Chrome, Firefox, and Safari by running <code>pack_mac.sh</code>.
<li>Binaries can be found in <code>bin/mac/</code>.</li>
</ol>
<h3>Windows</h3>
To package SockIt on Windows, add Chrome to your <code>PATH</code>.
<ol>
<li>Package SockIt for Safari, Chrome, and Firefox on Windows by running <code>pack_win.bat</code>.</li>
<li>Binaries can be found in <code>bin/win/</code>.</li>
</ol>
</div>
<br/>
<center>
<a href="index.html">Home</a> · <a href="tutorial.html">Quick Tutorial</a> · <a href="full_tutorial.html">Full Tutorial</a> · <a href="demos.html">Demos</a> · <a href="api_documentation.html">API</a> · <a href="html/index.html">Source Documentation</a> · <a href="developers.html">Developers</a>
</center>
</body>
</html>