iOS Ports
=========

   iOS Ports is a Collection of F/OSS libraries which have been ported to
   the iPhoneOS/iOS platform.  The conditions of the license of each package
   included in iOS Ports are believed to allow for use of each package on
   an iOS device, however a developer should review the license of each
   package before including it within an application and to verify that the
   application meets the requirements of the conditions.


Contents
--------

   1. Disclaimer
   2. Software Requirements
   3. Directory Map
   4. Packages
   5. Quick Start for Xcode 4.2
   6. Maintainers
   7. Community
   8. Source Code


Disclaimer
==========

   This software is provided by the copyright holders and contributors "as
   is" and any express or implied warranties, including, but not limited to,
   the implied warranties of merchantability and fitness for a particular
   purpose are disclaimed. In no event shall Bindle Binaries be liable for
   any direct, indirect, incidental, special, exemplary, or consequential
   damages (including, but not limited to, procurement of substitute goods or
   services; loss of use, data, or profits; or business interruption) however
   caused and on any theory of liability, whether in contract, strict
   liability, or tort (including negligence or otherwise) arising in any way
   out of the use of this software, even if advised of the possibility of
   such damage.


Software Requirements
=====================

   Git 1.7.2.3
   Mac OS X 10.7.1
   Xcode 4.2
   iOS SDK 5.0


Directory Map
=============

   .gitignore           - Global list of files to ignore
   LICENSE              - Software license of source code created for the
                          iOSPorts package.
   Makefile             - used to perform various global tasks
   README               - This file.
   build-aux/           - directory containing support scripts and utilities
   iOSPorts.xcworkspace - Xcode workspace
   include/             - Ports will install required header files to this
                          directory
   ports/               - contains all ports
   ports/database/      - Database Clients and Tools
   ports/devel/         - Development Tools and Libraries
   ports/iOSports/      - internal source code for iOSPorts support tools
   ports/security/      - Security Related Tools and Libraries
   examples/            - contains example code for iOS ports packages


Packages
========

   Cyrus SASL
   Location:      ports/security/cyrus-sasl/Cyrus SASL.xcodeproj
   Includes:      ports/security/openssl/openssl.xcodeproj
   Link With:     libsasl2.a libssl.a libcrypto.a
   Description:   A port of Cyrus SASL to the iPhone platform (iOS). An open
                  source implementations of Simple Authentication and Security
                  Layer methods.


   iOSPorts
   Location:      ports/iOSPorts/iOSPorts.xcodeproj
   Depends Upon:  n/a
   Links With:    n/a
   Description:   A standalone package for adding iOS Port packages' copyright
                  information to an iOS package.  Using this library to
                  display the copyright information should fulfill a packages
                  distribution requirement according to the Modified BSD
                  license and similar licenses. Including this project in an
                  iOS application will not make other iOS Ports packages
                  available within an application.


   OpenLDAP
   Location:     ports/database/openldap/openldap.xcodeproj
   Depends Upon: security/cyrus-sasl
   Links With:   libssl.a libcrypto.a libsasl2.a
   Desciption:   A port of OpenLDAP client library to the iOS platform.


   OpenSSL
   Location:      ports/security/openssl
   Depends Upon:  n/a
   Description:   A port of OpenSSL's SSL/TLS and Crypto toolkit to the iPhone
                  platform (iOS).


   PCRE
   Location:      ports/devel/pcre
   Depends Upon:  n/a
   Links With:    n/a
   Description:   A port of PCRE (Perl Compatible Regular Expressions) to the
                  iOS platform (iPhone).


   scrypt
   Location:      ports/security/scrypt/scrypt.xcodeproj
   Includes:      ports/security/openssl/openssl.xcodeproj
   Link With:     libcrypto.a
   Description:   The scrypt key derivation function was originally developed
                  for use in the Tarsnap online backup system and is designed
                  to be far more secure against hardware brute-force attacks
                  than alternative functions such as PBKDF2 or bcrypt.


Quick Start for Xcode 4.2
=========================

Needs to be written.


Maintainers
===========

   David M. Syzdek
   Bindle Binaries
   [email protected]


Community
=========

   Mailing List:
      [email protected]
      https://lists.bindlebinaries.com/mailman/listinfo/ios-ports

   Wiki:
      https://github.com/bindle/iOSPorts/wiki

   Issue Tracking:
      https://github.com/bindle/iOSPorts/issues


Source Code
===========

The source code for this project is maintained using git (http://git-scm.com).
The following contains information to checkout the source code from the git
repository.

   Git URLs:
      git://github.com/bindle/iOSPorts.git
      git://git.scm.bindlebinaries.com/pub/scm/com.bindlebinaries/iOSPorts.git
      http://http.scm.bindlebinaries.com/pub/scm/com.bindlebinaries/iOSPorts.git
      ssh://ssh.scm.bindlebinaries.com/pub/scm/com.bindlebinaries/iOSPorts.git

   Downloading Source:

      $ git clone git://github.com/bindle/iOSPorts.git

   Git Branches:
      master - Current release of packages.
      next   - changes staged for next release
      pu     - proposed updates for next release
      xx/yy+ - branch for testing new changes before merging to 'pu' branch