Skip to content

Commit 01019f4

Browse files
Micah Leepde
authored andcommitted
updated readme to add Linux and OSX build instructions, and changing the format to markdown
https://trac.torproject.org/projects/tor/ticket/9139
1 parent cd69577 commit 01019f4

File tree

2 files changed

+56
-14
lines changed

2 files changed

+56
-14
lines changed

README

Lines changed: 0 additions & 14 deletions
This file was deleted.

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
HTTPS Everywhere
2+
================
3+
4+
Installing Dependencies in Debian or Ubuntu
5+
-------------------------------------------
6+
7+
sudo apt-get install python-lxml python-libxml2
8+
9+
Installing Dependencies in Mac OS X
10+
-----------------------------------
11+
12+
We recommend Mac users install dependencies using Homebrew:
13+
http://mxcl.github.io/homebrew/
14+
15+
Once you have Homebrew and Xcode installed, run this to install HTTPS Everywhere dependencies.
16+
17+
brew install python libxml2 gnu-sed
18+
19+
Homebrew puts python in /usr/local/bin, but the python that comes with OS X is in /usr/bin. In order to use homebrew's version of python and pip you must change the order of your path so that /usr/local/bin comes before /usr/bin. This command will force your path to start with /usr/local/bin:
20+
21+
echo PATH=/usr/local/bin:$PATH >> ~/.profile
22+
23+
After running this close your terminal and then open it again. Then install lxml using pip.
24+
25+
pip install lxml
26+
27+
Build Instructions
28+
------------------
29+
30+
To build the Firefox version go to the git repository root and run:
31+
32+
./makexpi.sh
33+
34+
To build the Chrome version go to the git repository root and run:
35+
36+
./makecrx.sh
37+
38+
After building the extension the xpi files (for Firefox) and crx files (for Chrome) get created in the pkg directory. You can open those files within your browser to install the browser extension.
39+
40+
Source Tree
41+
-----------
42+
43+
This is the source tree for HTTPS Everywhere for Firefox and Chrome.
44+
45+
Important directories you might want to know about
46+
47+
src/ The Firefox source
48+
49+
chromium/ The Chromium/Chrome source
50+
(not to be confused with Firefox browser "chrome" or UI)
51+
52+
src/components |
53+
src/chrome/content | Firefox JavaScript and XUL code
54+
src/chrome/content/code |
55+
56+
src/chrome/content/rules The rulesets live here

0 commit comments

Comments
 (0)