README added

IRCClient.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		86B6232A1C21FC6D00D6E3AF /* README in Resources */ = {isa = PBXBuildFile; fileRef = 86B623291C21FC6D00D6E3AF /* README */; };
 		86F2EFEA1C21F73600B033A4 /* IRCClient.h in Headers */ = {isa = PBXBuildFile; fileRef = 86F2EFE91C21F73600B033A4 /* IRCClient.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		86F2EFF81C21F81900B033A4 /* IRCClientChannel_Private.h in Headers */ = {isa = PBXBuildFile; fileRef = 86F2EFF11C21F81900B033A4 /* IRCClientChannel_Private.h */; };
 		86F2EFF91C21F81900B033A4 /* IRCClientChannel.h in Headers */ = {isa = PBXBuildFile; fileRef = 86F2EFF21C21F81900B033A4 /* IRCClientChannel.h */; };
@@ -18,6 +19,7 @@
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
+		86B623291C21FC6D00D6E3AF /* README */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README; sourceTree = "<group>"; };
 		86F2EFE61C21F73600B033A4 /* IRCClient.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = IRCClient.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		86F2EFE91C21F73600B033A4 /* IRCClient.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = IRCClient.h; sourceTree = "<group>"; };
 		86F2EFEB1C21F73600B033A4 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
@@ -60,6 +62,7 @@
 		86F2EFE81C21F73600B033A4 /* IRCClient */ = {
 			isa = PBXGroup;
 			children = (
+				86B623291C21FC6D00D6E3AF /* README */,
 				86F2EFF11C21F81900B033A4 /* IRCClientChannel_Private.h */,
 				86F2EFF21C21F81900B033A4 /* IRCClientChannel.h */,
 				86F2EFF31C21F81900B033A4 /* IRCClientChannel.m */,
@@ -146,6 +149,7 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				86B6232A1C21FC6D00D6E3AF /* README in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -306,6 +310,7 @@
 				86F2EFF01C21F73600B033A4 /* Release */,
 			);
 			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
 		};
 /* End XCConfigurationList section */
 	};

IRCClient/IRCClient.h

@@ -2,9 +2,19 @@
 //  IRCClient.h
 //  IRCClient
 //
-//  Created by Sandy Achmiz on 12/16/15.
-//  Copyright © 2015 Said Achmiz. All rights reserved.
+//  Copyright © 2015 Said Achmiz.
 //
+/*
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ */
 
 #import <Cocoa/Cocoa.h>
 

IRCClient/README

@@ -0,0 +1,29 @@
+This is a modified version of the IRCClient framework by Nathan Ollerenshaw. I’ve rewritten it to allow robust support for arbitrary text encodings, and fixed various other problems. The original version is available here: http://sourceforge.net/projects/libircclient/ (distributed alongside the libircclient library).
+
+- Said Achmiz
+
+Original README follows:
+
+—
+
+IRCClient.framework 1.0 by Nathan Ollerenshaw (chrome@stupendous.net)
+
+This is a Cocoa framework wrapper around Georgy Yunaev's (gyunaev@ulduzsoft.com)
+excellent libircclient library.
+
+While Georgy's library is portable, obviously this Cocoa framework is specific
+to Mac OS X systems. Though you might be able to get it working under
+cocotron or GNUstep, those implementations of Cocoa are not supported.
+
+To build the framework, you will need to configure libircclient library first. 
+From the Terminal, run the following command in the distribution directory:
+
+ ./configure --enable-thread --enable-ipv6
+
+The Xcode project is configured to include the libircclient.c source.
+
+The framework is configured to build with a relative path of ../Frameworks/ so
+it can be easily embedded in your application.
+
+For documentation, examine the header files or read the Doxygen documentations
+in 'doc'.