Added SILC Thread Queue API
[runtime.git] / apps / silcer / README
1 Silcer Gnome SILC Client
2 ========================
3
4 This is Silcer, the Gnome SILC Client.  It is only provided with SILC 
5 Toolkit package as an example GUI application, to show how to program with 
6 SILC Toolkit.  It is a good example for all GUI programmers to figure out 
7 how to hook up SILC Toolkit, and in the end the SILC Client Library to a 
8 GUI application.
9
10 The silcer.png file found in this package is a screenshot of the 
11 application in action.  You can compile it by running first the 
12 ./autogen.sh script and then giving command `make' or `gmake'.
13
14 When you run the silcer you must run it by giving command src/silcer 
15 because it will attempt to look for GUI files in the ui/ directory found 
16 in this package.  So, do not enter src/ directory, but run it directly 
17 from the root where you gave the make command.
18
19 When the program starts it will attempt to connect directly to 
20 silc.silcnet.org router on port 706.  After it has connected you can 
21 freely use it as any SILC client.  In the input box on the screen you can 
22 give commands.  Commands, such as /nick, /join, etc.  The application is 
23 only an example so all features has not been implemented.  For example 
24 various command notifications and other notifications are not implemented 
25 on the screen.  This means that when you give command /nick you won't 
26 actually see whether your nickname changed or not.  But it did. :)  Same 
27 is when you join to a channel by giving command /join you won't get list 
28 of users or other familiar things.  This is because those notifications 
29 has not been implemented.  They are left as an exerise for Toolkit 
30 programmers.  You can still converse on a channel.  You will see other 
31 users' messages on the channel and you can talk to the channel, so you can 
32 test the application if you like.
33
34 The sources resides in the src/ directory and are C++.  The GUI files 
35 resides in ui/ directory and was done with glade.
36
37 Happy hacking!