Update directions, copyrights, and clarify licenses of polipo
[tor/rransom.git] / contrib / polipo / README
blob038e3544132ada69ebaa9c84296cfbe32bf0aff9
1 Copyright 2007-2008 Andrew Lewman
2 ----------------
3 General Comments
4 ----------------
6 These are some hacks for making polipo work and install a package native
7 to OSX or Windows.
9 They need some work before they can be committed upstream:
10   - Merge the three makefiles into one with specific builds such as "make
11     dist-osx" or "make dist-win32"
12   - Configure the options for tor in polipo config, just leave them
13     commented out for easy activation.
14   - Work out better polipo config options for Tor.  
16 As always, I'm happy to accept patches.
18 --------------------------
19 Pre-requisites for Windows
20 --------------------------
22 Polipo for Win32 requires the mingw gnu regex library and dlls at
23 http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=73286&release_id=140957
25 You'll need to download the -bin and -dev tarballs.  And extract them
26 into your MinGW directory.
28 Instructions for building polipo under mingw32 for Windows:
29 1) Copy Makefile.mingw over Makefile.
30 2) Run 'make'. 
32 You should have a polipo.exe in the current directory.
34 -------------------------------------------
35 Creating an installation package in Windows
36 -------------------------------------------
38 If you want to build an installer using the Nullsoft Installer, install
39 the NSI Compiler.  In Windows Explorer, navigate to the directory in
40 which you placed polipo-mingw.nsi.  Right click on polipo-mingw.nsi and
41 choose Compile NSIS Script.  You'll then create a polipo installer.
43 The Polipo NSI installer assumes libgnurx-0.dll is in the same directory as polipo.exe.
44 You'll need to copy libgnurx-0.dll into "./" in order to make the
45 installation package.
47 ---------------------------------------------
48 OSX Universal Binary and Installation package
49 ---------------------------------------------
50 1) Copy Makefile.osx over Makefile.
51 2) Run 'make'.
52 3) Copy the contents of this directory into a directory named "contrib".
53 4) Run './contrib/package.sh'
54 5) You should have a Polipo-version.dmg ready for installation.