ADDED README Index: README ================================================================== --- README +++ README @@ -0,0 +1,43 @@ +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 operation systems or various frameworks that you +would otherwise need if you want to be portable. + +See https://webkeks.org/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 Mercurial repository, you need + to run the following command first: + + $ ./autogen.sh + + +BUILDING AS A MAC OS X FRAMEWORK + + It is also possible to build ObjFW as a Mac OS X framework. To do so, + just execute xcodebuild in the root directory of ObjFW or 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 MAC OS X FRAMWORK IN XCODE + + To use the Mac OS X framework in Xcode, you need to add the .framework + to your project and add the following flags to "Other C Flags": + + -fconstant-string-class=OFConstString -fno-constant-cfstrings + + +BUGS AND FEATURE REQUESTS + + If you find any bugs or have feature requests, feel free to send a + mail to js-spam@webkeks.org (remove -spam from the address!).