adium: document release archive creation
[siplcs.git] / src / adium / README.Adium
blob4400ecf840ae3795e3c6903858362d6759633b37
1 Compiling SIPE plugin for Adium
2 ===============================
4 To compile the Adium plugin you will need Xcode and the source code from
5 the following URLs:
7 - Adium 1.5+:      http://trac.adium.im/wiki/GettingNewestAdiumSource
8 - OpenSSL 0.9.8za: https://www.openssl.org/source/old/0.9.x/openssl-0.9.8za.tar.gz
9 - SIPE:            http://sourceforge.net/projects/sipe/files/sipe/
12 1. Get Adium
13 ------------
15 NOTE: you only have to do this step once. If you don't change the Adium
16       source code, then you can reuse the results from this step in future
17       SIPEAdiumPlugin builds.
19 Follow the instructions at their URL above.
21 The directory needs to be called "adium" and must be located at the same
22 level as the SIPE source code directory.
25 2. Get OpenSSL
26 --------------
28 NOTE: you only have to do this step once. If you don't change the OpenSSL
29       source code, then you can reuse the results from this step in future
30       SIPEAdiumPlugin builds.
32 Execute the following commands in the Terminal application to download and
33 unpack the source code:
35     $ cd my_working_directory
36     $ curl -o openssl-0.9.8za.tar.gz https://www.openssl.org/source/old/0.9.x/openssl-0.9.8za.tar.gz
37     $ tar -xf openssl-0.9.8za.tar.gz
39 The directory needs to be called "openssl-0.9.8za" and must be located at
40 the same level as the SIPE source code directory.
43 3. Build the SIPEAdiumPlugin Xcode project
44 ------------------------------------------
46 In Xcode go to the Menu File -> Open..., browse to the location of your SIPE
47 source tree, go into the src/adium directory, select SIPEAdiumPlugin.xcodeproj
48 and press "Open".
50 NOTE: please always make sure that the correct scheme has been selected by
51       selecting the menu Product -> Scheme -> SIPEAdiumPlugin. Otherwise you
52       will get cryptic build failures.
54 Now you can just select Product -> Build and after a short while you should
55 get a SIPEAdiumPlugin binary that you can install into your Adium application. 
58 4. Generate & verify the release archive
59 ----------------------------------------
61 The build copies the files into your Adium plugin directory. Use the following
62 commands to generate the release archive:
64     $ cd ~/Library/Application\ Support/Adium\ 2.0/PlugIns
65     $ zip -r ~/SIPEAdiumPlugin.zip SIPEAdiumPlugin.AdiumLibpurplePlugin/
67 You need to have a bash 4 to run the verification script, e.g. on a Linux box
69     $ src/adium/check_release.sh ~/SIPEAdiumPlugin.zip
72 5. Build SIPEAdiumPlugin for an older Max OS X release
73 ------------------------------------------------------
75 If your Xcode does not have the SDK for the older Mac OS X release then please
76 see
78     https://github.com/devernay/xcodelegacy
80 how to extract & install SDKs for
82     - OS X 10.9 & 10.10 from the Xcode 6.4 installation package
83     - OS X 10.11 from the Xcode 7.3.1 installation package
85 Installing all SDKs in one go seems to break Xcode builds, so please make sure
86 to install each SDK separately with
88     $ sudo ./XcodeLegacy.sh -osxXXXX install
90 Xcode no longer seems to apply project build settings top-down. To make
91 changes please
93     - select the SIPEAdiumPlugin or Adium project
94     - select the "Build Settings" tab
95     - change from "Basic" to "All" (on the left)
96     - change from "Combined" to "Levels" (in the middle)
97     - find the line with the setting you want to change (use search field)
98     - select that line
99     - change the setting at the right-most(!) place in that line
100     - you will notice that all places to the left change automatically
102 Settings to change
104     SDK to    |  Base SDK  | Implicitly Link Objective-C  | Other
105     build for |            | Runtime Support (Adium only) |
106    -----------|------------|------------------------------|-------------------
107      10.11    | OS X 10.11 |    <No change necessary>     |
108      10.10    | OS X 10.10 |    <No change necessary>     | Adium <= 1.5.10.3
109      10.9     | OS X 10.9  |            No                | Adium <= 1.5.10.3