merge refactor IOS-1542
authorDirk Zimmermann <dz@pep.security>
Thu, 18 Apr 2019 07:51:46 +0200
branchIOS-1542
changeset 8312e59c460fd936
parent 8291 911ad6f45266
parent 8311 b3c93c82ed21
child 8321 8943ce579269
merge refactor
     1.1 --- a/README.md	Wed Apr 17 16:22:49 2019 +0200
     1.2 +++ b/README.md	Thu Apr 18 07:51:46 2019 +0200
     1.3 @@ -26,9 +26,17 @@
     1.4  sudo port install automake
     1.5  
     1.6  sudo port install gmake
     1.7 +
     1.8 +# To run the `greenmail` mailserver for tests
     1.9 +sudo port install openjdk11
    1.10  ```
    1.11  
    1.12 -### Other dependecies
    1.13 +### Set up Xcode
    1.14 +You need to have an Apple ID configured in Xcode, for code signing. You can add one in the `Accounts` tab of the settings (menu `Xcode > Preferences...`).
    1.15 +
    1.16 +For some things (TODO: what exactly?), your Apple ID needs to be part of the pEp team account. Ask `#service`, if you want to be added to the team account. When you are a member of the team, the information on your Apple ID in the Xcode Preferences should have a record `Team: pEp Security SA`, `Role: Member`.
    1.17 +
    1.18 +### Other dependencies
    1.19  
    1.20  #### pEpEngine: [yml2](https://fdik.org/yml/toolchain)
    1.21  
    1.22 @@ -104,3 +112,61 @@
    1.23  OAUTH2_YAHOO_CLIENT_SECRET = some_content
    1.24  
    1.25  ```
    1.26 +
    1.27 +# Notes on debugging build problems
    1.28 +Depending on whether you use a distribution of bash from macports or Apple, and the contents of your `PATH` variable, the build might fail. Especially the engine makes many assumptions about the environment on the build machine.
    1.29 +
    1.30 +If you have any build issues, they may also be fixed by changing some of the variables the engine build system uses in `~/src/pEpEngine/local.conf`. This is an example configuration file:
    1.31 +
    1.32 +~~~
    1.33 +YML2_PROC=/opt/local/bin/python2 $(YML2_PATH)/yml2proc
    1.34 +
    1.35 +ASN1C=/opt/local/bin/asn1c
    1.36 +ASN1C_INC=/opt/local/share/asn1c/
    1.37 +~~~
    1.38 +
    1.39 +Note that some of these variables may be overridden in the build system elsewhere, for example the variable `YML2_PATH`. Check the build steps in `pEpEngine.xcodeproj` for details.
    1.40 +
    1.41 +# Misc
    1.42 +For a quick update of all the code repositories cloned in the instructions above, use this shell script snipped:
    1.43 +
    1.44 +~~~
    1.45 +cd ~/yml2/
    1.46 +hg pull -u
    1.47 +
    1.48 +cd ~/src/libetpan/
    1.49 +git pull
    1.50 +
    1.51 +cd ~/src/OpenSSL-for-iPhone/
    1.52 +git pull
    1.53 +
    1.54 +cd ~/src/SwipeCellKit/
    1.55 +git pull
    1.56 +
    1.57 +cd ~/src/AppAuth-iOS/
    1.58 +git pull
    1.59 +
    1.60 +cd ~/src/ldns/
    1.61 +git pull
    1.62 +
    1.63 +cd ~/src/pantomime-iOS/
    1.64 +hg pull -u
    1.65 +
    1.66 +cd ~/src/netpgp-et/
    1.67 +hg pull -u
    1.68 +
    1.69 +cd ~/src/pEpEngine/
    1.70 +hg pull -u
    1.71 +
    1.72 +cd ~/src/pEpObjCAdapter/
    1.73 +hg pull -u
    1.74 +
    1.75 +cd ~/src/MessageModel/
    1.76 +hg pull -u
    1.77 +
    1.78 +cd ~/src/libAccountSettings/
    1.79 +hg pull -u
    1.80 +
    1.81 +cd ~/src/pEp_for_iOS/
    1.82 +hg pull -u
    1.83 +~~~