Updated documentation
This commit is contained in:
parent
5686262717
commit
ae40b333fd
@ -7,13 +7,13 @@
|
|||||||
objects = {
|
objects = {
|
||||||
|
|
||||||
/* Begin PBXBuildFile section */
|
/* Begin PBXBuildFile section */
|
||||||
868374A91C24E774005B97E5 /* IRCClient.h in Headers */ = {isa = PBXBuildFile; fileRef = 868374A81C24E774005B97E5 /* IRCClient.h */; };
|
866EF0101C25FF07006303A1 /* libircclient.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 866EF00F1C25FF07006303A1 /* libircclient.a */; };
|
||||||
|
868374A91C24E774005B97E5 /* IRCClient.h in Headers */ = {isa = PBXBuildFile; fileRef = 868374A81C24E774005B97E5 /* IRCClient.h */; settings = {ATTRIBUTES = (Public, ); }; };
|
||||||
86B6232C1C21FD7C00D6E3AF /* README in Resources */ = {isa = PBXBuildFile; fileRef = 86B6232B1C21FD7C00D6E3AF /* README */; };
|
86B6232C1C21FD7C00D6E3AF /* README in Resources */ = {isa = PBXBuildFile; fileRef = 86B6232B1C21FD7C00D6E3AF /* README */; };
|
||||||
86D784A61C24C39F00C7458D /* libirc_errors.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A01C24C39F00C7458D /* libirc_errors.h */; };
|
86D784A61C24C39F00C7458D /* libirc_errors.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A01C24C39F00C7458D /* libirc_errors.h */; };
|
||||||
86D784A71C24C39F00C7458D /* libirc_events.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A11C24C39F00C7458D /* libirc_events.h */; };
|
86D784A71C24C39F00C7458D /* libirc_events.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A11C24C39F00C7458D /* libirc_events.h */; };
|
||||||
86D784A81C24C39F00C7458D /* libirc_options.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A21C24C39F00C7458D /* libirc_options.h */; };
|
86D784A81C24C39F00C7458D /* libirc_options.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A21C24C39F00C7458D /* libirc_options.h */; };
|
||||||
86D784A91C24C39F00C7458D /* libirc_rfcnumeric.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A31C24C39F00C7458D /* libirc_rfcnumeric.h */; };
|
86D784A91C24C39F00C7458D /* libirc_rfcnumeric.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A31C24C39F00C7458D /* libirc_rfcnumeric.h */; };
|
||||||
86D784AA1C24C39F00C7458D /* libircclient.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 86D784A41C24C39F00C7458D /* libircclient.a */; };
|
|
||||||
86D784AB1C24C39F00C7458D /* libircclient.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A51C24C39F00C7458D /* libircclient.h */; };
|
86D784AB1C24C39F00C7458D /* libircclient.h in Headers */ = {isa = PBXBuildFile; fileRef = 86D784A51C24C39F00C7458D /* libircclient.h */; };
|
||||||
86F2EFF81C21F81900B033A4 /* IRCClientChannel_Private.h in Headers */ = {isa = PBXBuildFile; fileRef = 86F2EFF11C21F81900B033A4 /* IRCClientChannel_Private.h */; };
|
86F2EFF81C21F81900B033A4 /* IRCClientChannel_Private.h in Headers */ = {isa = PBXBuildFile; fileRef = 86F2EFF11C21F81900B033A4 /* IRCClientChannel_Private.h */; };
|
||||||
86F2EFF91C21F81900B033A4 /* IRCClientChannel.h in Headers */ = {isa = PBXBuildFile; fileRef = 86F2EFF21C21F81900B033A4 /* IRCClientChannel.h */; };
|
86F2EFF91C21F81900B033A4 /* IRCClientChannel.h in Headers */ = {isa = PBXBuildFile; fileRef = 86F2EFF21C21F81900B033A4 /* IRCClientChannel.h */; };
|
||||||
@ -25,13 +25,13 @@
|
|||||||
/* End PBXBuildFile section */
|
/* End PBXBuildFile section */
|
||||||
|
|
||||||
/* Begin PBXFileReference section */
|
/* Begin PBXFileReference section */
|
||||||
|
866EF00F1C25FF07006303A1 /* libircclient.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; path = libircclient.a; sourceTree = "<group>"; };
|
||||||
868374A81C24E774005B97E5 /* IRCClient.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IRCClient.h; sourceTree = "<group>"; };
|
868374A81C24E774005B97E5 /* IRCClient.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IRCClient.h; sourceTree = "<group>"; };
|
||||||
86B6232B1C21FD7C00D6E3AF /* README */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README; sourceTree = "<group>"; };
|
86B6232B1C21FD7C00D6E3AF /* README */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README; sourceTree = "<group>"; };
|
||||||
86D784A01C24C39F00C7458D /* libirc_errors.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_errors.h; sourceTree = "<group>"; };
|
86D784A01C24C39F00C7458D /* libirc_errors.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_errors.h; sourceTree = "<group>"; };
|
||||||
86D784A11C24C39F00C7458D /* libirc_events.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_events.h; sourceTree = "<group>"; };
|
86D784A11C24C39F00C7458D /* libirc_events.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_events.h; sourceTree = "<group>"; };
|
||||||
86D784A21C24C39F00C7458D /* libirc_options.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_options.h; sourceTree = "<group>"; };
|
86D784A21C24C39F00C7458D /* libirc_options.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_options.h; sourceTree = "<group>"; };
|
||||||
86D784A31C24C39F00C7458D /* libirc_rfcnumeric.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_rfcnumeric.h; sourceTree = "<group>"; };
|
86D784A31C24C39F00C7458D /* libirc_rfcnumeric.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libirc_rfcnumeric.h; sourceTree = "<group>"; };
|
||||||
86D784A41C24C39F00C7458D /* libircclient.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; path = libircclient.a; sourceTree = "<group>"; };
|
|
||||||
86D784A51C24C39F00C7458D /* libircclient.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libircclient.h; sourceTree = "<group>"; };
|
86D784A51C24C39F00C7458D /* libircclient.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = libircclient.h; sourceTree = "<group>"; };
|
||||||
86F2EFE61C21F73600B033A4 /* IRCClient.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = IRCClient.framework; sourceTree = BUILT_PRODUCTS_DIR; };
|
86F2EFE61C21F73600B033A4 /* IRCClient.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = IRCClient.framework; sourceTree = BUILT_PRODUCTS_DIR; };
|
||||||
86F2EFEB1C21F73600B033A4 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
|
86F2EFEB1C21F73600B033A4 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
|
||||||
@ -49,7 +49,7 @@
|
|||||||
isa = PBXFrameworksBuildPhase;
|
isa = PBXFrameworksBuildPhase;
|
||||||
buildActionMask = 2147483647;
|
buildActionMask = 2147483647;
|
||||||
files = (
|
files = (
|
||||||
86D784AA1C24C39F00C7458D /* libircclient.a in Frameworks */,
|
866EF0101C25FF07006303A1 /* libircclient.a in Frameworks */,
|
||||||
);
|
);
|
||||||
runOnlyForDeploymentPostprocessing = 0;
|
runOnlyForDeploymentPostprocessing = 0;
|
||||||
};
|
};
|
||||||
@ -59,11 +59,11 @@
|
|||||||
86D7849F1C24C39F00C7458D /* libircclient */ = {
|
86D7849F1C24C39F00C7458D /* libircclient */ = {
|
||||||
isa = PBXGroup;
|
isa = PBXGroup;
|
||||||
children = (
|
children = (
|
||||||
|
866EF00F1C25FF07006303A1 /* libircclient.a */,
|
||||||
86D784A01C24C39F00C7458D /* libirc_errors.h */,
|
86D784A01C24C39F00C7458D /* libirc_errors.h */,
|
||||||
86D784A11C24C39F00C7458D /* libirc_events.h */,
|
86D784A11C24C39F00C7458D /* libirc_events.h */,
|
||||||
86D784A21C24C39F00C7458D /* libirc_options.h */,
|
86D784A21C24C39F00C7458D /* libirc_options.h */,
|
||||||
86D784A31C24C39F00C7458D /* libirc_rfcnumeric.h */,
|
86D784A31C24C39F00C7458D /* libirc_rfcnumeric.h */,
|
||||||
86D784A41C24C39F00C7458D /* libircclient.a */,
|
|
||||||
86D784A51C24C39F00C7458D /* libircclient.h */,
|
86D784A51C24C39F00C7458D /* libircclient.h */,
|
||||||
);
|
);
|
||||||
path = libircclient;
|
path = libircclient;
|
||||||
@ -110,8 +110,8 @@
|
|||||||
isa = PBXHeadersBuildPhase;
|
isa = PBXHeadersBuildPhase;
|
||||||
buildActionMask = 2147483647;
|
buildActionMask = 2147483647;
|
||||||
files = (
|
files = (
|
||||||
86F2EFFE1C21F81900B033A4 /* IRCClientSessionDelegate.h in Headers */,
|
|
||||||
868374A91C24E774005B97E5 /* IRCClient.h in Headers */,
|
868374A91C24E774005B97E5 /* IRCClient.h in Headers */,
|
||||||
|
86F2EFFE1C21F81900B033A4 /* IRCClientSessionDelegate.h in Headers */,
|
||||||
86D784AB1C24C39F00C7458D /* libircclient.h in Headers */,
|
86D784AB1C24C39F00C7458D /* libircclient.h in Headers */,
|
||||||
86D784A61C24C39F00C7458D /* libirc_errors.h in Headers */,
|
86D784A61C24C39F00C7458D /* libirc_errors.h in Headers */,
|
||||||
86F2EFF91C21F81900B033A4 /* IRCClientChannel.h in Headers */,
|
86F2EFF91C21F81900B033A4 /* IRCClientChannel.h in Headers */,
|
||||||
|
|||||||
@ -743,7 +743,6 @@ static void onChannelPrvmsg(irc_session_t *session, const char *event, const cha
|
|||||||
message = [NSData dataWithBytes:params[1] length:strlen(params[1])];
|
message = [NSData dataWithBytes:params[1] length:strlen(params[1])];
|
||||||
}
|
}
|
||||||
|
|
||||||
NSLog(@"onChannelPrvmsg");
|
|
||||||
[clientSession messageSent:message toChannel:channelName byUser:nick];
|
[clientSession messageSent:message toChannel:channelName byUser:nick];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -99,7 +99,7 @@
|
|||||||
*
|
*
|
||||||
* @param channel the channel for the invitation.
|
* @param channel the channel for the invitation.
|
||||||
* @param nick the nickname of the user that sent the invitation.
|
* @param nick the nickname of the user that sent the invitation.
|
||||||
*/
|
*/
|
||||||
- (void)invitedToChannel:(NSData *)channelName by:(NSString *)nick;
|
- (void)invitedToChannel:(NSData *)channelName by:(NSString *)nick;
|
||||||
|
|
||||||
/** A private CTCP request was sent to the IRC client.
|
/** A private CTCP request was sent to the IRC client.
|
||||||
|
|||||||
2
README
2
README
@ -8,6 +8,8 @@ ADDING IRCCLIENT TO YOUR APPLICATION
|
|||||||
(using Xcode)
|
(using Xcode)
|
||||||
(these instructions apply to Xcode 7.1.1, build 7B1005)
|
(these instructions apply to Xcode 7.1.1, build 7B1005)
|
||||||
|
|
||||||
|
0. Build libircclient and add it to the IRCClient project (see file “README_libircclient” for details)
|
||||||
|
|
||||||
1. Place the entire IRCClient folder in your project folder
|
1. Place the entire IRCClient folder in your project folder
|
||||||
|
|
||||||
2. Using “File -> Add Files…”, add IRCClient.xcodeproj to your project
|
2. Using “File -> Add Files…”, add IRCClient.xcodeproj to your project
|
||||||
|
|||||||
18
README_libircclient
Normal file
18
README_libircclient
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
Before you can add IRCClient to your project, you must build libircclient and add it to IRCClient.
|
||||||
|
(these instructions apply to Xcode 7.1.1, build 7B1005)
|
||||||
|
|
||||||
|
0. Download the libircclient source
|
||||||
|
|
||||||
|
1. Create a folder called “libircclient” in the IRCClient project folder
|
||||||
|
|
||||||
|
2. Build libircclient, according the instructions provided
|
||||||
|
|
||||||
|
3. Place the library (libircclient.a) and the headers (libircclient.h, libirc_errors.h, libirc_events.h, libirc_options.h, and libirc_rfcnumeric.h) into the libircclient folder you created
|
||||||
|
|
||||||
|
4. Open IRCClient.xcodeproj in Xcode and use “File -> Add Files…” to add the libircclient folder to the project
|
||||||
|
|
||||||
|
5. Configure the build phases for the IRCClient framework target by adding libircclient.a to the “Link Binary With Libraries” build phase
|
||||||
|
|
||||||
|
6. Close the project
|
||||||
|
|
||||||
|
Now you can proceed with step 1 of the instructions in the main README file.
|
||||||
Loading…
Reference in New Issue
Block a user