ObjFW  README.md at [0a13f77dc5]

File README.md artifact d1192574f1 part of check-in 0a13f77dc5


ObjFW is a portable, lightweight framework for the Objective C language.
It enables you to write an application in Objective C that will run on
any platform supported by ObjFW without having to worry about
differences between operating systems or various frameworks that you
would otherwise need if you want to be portable.

See https://heap.zone/objfw for more information.


Installation
============

  To install ObjFW, just run the following commands:

    $ ./configure
    $ make
    $ make install

  In case you checked out ObjFW from the Git repository, you need to run
  the following command first:

    $ autoreconf


Building as a macOS or iOS framework
====================================

  It is also possible to build ObjFW as a macOS framework. To do so, just
  execute `xcodebuild -target 'ObjFW (Mac)'` in the root directory of ObjFW to
  build it as a macOS framework or `xcodebuild -target 'ObjFW (iOS)'` to build
  it as an iOS framework; alternatively, you can open the .xcodeproj in Xcode
  and choose Build -> Build from the menu. Copy the resulting ObjFW.framework
  to `/Library/Frameworks` and you are done.


Using the macOS or iOS framework in Xcode
=========================================

  To use the macOS framework in Xcode, you need to add the .framework to your
  project and add the following flags to `Other C Flags`:

    -fconstant-string-class=OFConstantString -fno-constant-cfstrings

  Optionally, if you want to use blocks, you also need to add:

    -fblocks


Bugs and feature requests
=========================

  If you find any bugs or have feature requests, feel free to send a
  mail to js@heap.zone!