**************************************************************************
*                 k-IRC  -  IRC Client for J2ME Platform                 *
*                                                                        *
*                Copyright (c) 2002-2003  Armond Avanes                  *
*            Refer to Software License For More Information              *
*                                                                        *
*                      Version 1.1  October 04, 2003                     *
*                                                                        *
*                                                                        *
*                                                                        *
*                           By: Armond Avanes                            *
*            Armond555@yahoo.com     &    Armond333@yahoo.com            *
*                      http://kirc.sourceforge.net/                      *
**************************************************************************


Table Of Contents
---------------------------------
1. Introduction
2. License Agreement & Copyright
3. Requirements
4. Build & Run (on Emulator) Process
5. Problems/Bug Reports & Feature Requests
6. Acknowledgments & Credits
7. More Information
8. Problems/Bug Reports & Feature Requests
9. Contact Information



1. Introduction
----------------
k-IRC is totally free java-based mobile application (client) for connecting to
any IRC server. It will execute on any handheld device or mobile, supporting 
Java 2 Micro Edition (actually CLDC1.0/MIDP1.0).
k-IRC allows you to login to an IRC server, enter multiple channels at the same
session, talk in the channels and with individuals and receive others' messages 
and easily keep the track of active channels and switch between them.

NOTE: For more information and a brief tour on how to use this application, 
      please refer to "docs/UserGuide.doc" file found in this bundle.



2. License Agreement & Copyright
---------------------------------
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

NOTE: All the source codes and doumentation included in this bundle are under GPL except
some of the sources which are under "org.relayirc.chatengine" and "org.relayirc.core"
packages which are licensed under MPL (Mozilla Public License) and have been used from
an open source application called *RelayIRC*.



3. Requirements
----------------
Your handheld or mobile device must support J2ME (CLDC1.0/MIDP1.0) in order
to run this application. Also you can run it on an emulation environment such
as "J2ME Wireless Toolkit" from Sun or other ones from Siemens, Nokia, etc.

Note: The only feature mobile set must support is establishing *TCP/IP Socket* 
      connection since the program tries to establish a direct socket connection 
      to IRC server.



4. Build & Run (on Emulator) Process
-------------------------------------
Before going to build process, it's neccessary to understand the directory structure 
of the project. Here is a summary:
- build:  A temporary place for putting compiled, obfuscated and preverified code 
          here before packaging them.
- config: Project configuration files will go here.
- dist:   Distribution directory! Here you can find all the result jar, jad and other 
          ready-to-use/ready-to-run files after the project got built successfully.
- doc:    All the project documentation files are here.
- lib:    Here you will find all the libraries for building and running the program.
          k-IRC doesn't need any extra library for its runtime so all the libraries you
          can see there now, are for build-time.
- script: All the scripts for building the project and running it on J2ME Wireless
          Toolkit (A J2ME Environment Emulator On PC) are here. Currently there
          are only windows script files (.bat) for invoking the build process but
          you can write your own since ANT (which a pure java-based tool) is used 
          for this purpose and you can invoke it from every platform supporting java!
          The main ANT script file which includes all the logic for building is the
          "build.xml" file.
          All the libraries you need for ANT is already included in "lib" directory so
          you don't need anything more.
- src:    All the source codes and resources can be found here.

Well, if you've got the "Full Development Distribution" of k-IRC (including source code,
documentation and binary form), you already have the ready-to-run version on "dist" 
directory (.jad and .jar). Go there, copy the .jar and .jad files to your J2ME enabled 
device and enjoy!

Otherwise for building the project just go to "script" directory and invoke the
"build.bat". After it went successfully, you can go to "dist" and there you'll find
all you need.

To prepare a "Full Source Distribution" of k-IRC, execute "src-dist.bat" and go to "dist".
The bundled *_dist-src.zip is there!

For running k-IRC on J2ME Wireless Toolkit, edit "build.properties" in "script" directory
and set the "j2mewtk.home" property's value to where J2MEWTK is installed on your computer.
Then execute the "run-on-emulator.bat" file.

NOTE: Since the source obfuscator which is used in k-IRC (Retrogaurd actually) has problems
      with JDK1.4.x, it's suggested to do the whole build under JDK1.3.x.



5. Problems/Bug Reports & Feature Requests
-------------------------------------------
Please feel free to send me your comments, questions & ideas as well as
the possible bugs you may get into. Helps are always welcome!
But first, please check the ToDo and Bugs list before contacting me. Maybe
the feature(s)/bug(s) you're going to request/report are already listed there.

Bug reports and feature requests can be directly emailed to me.



6. Acknowledgments & Credits
-----------------------------
Many thanks & credits go to David M. Johnson (snoopster64@yahoo.com &
snoopdave@users.sourceforge.net), the author of open source RelayIRC application 
(J2SE application). I've used RelayIRC's engine for talking to IRC servers and 
adapted it to work on J2ME platform according to the platform limitations and 
differences.



7. More Information
--------------------
You can find the latest information, releases and documentations at the
following address :
http://kirc.sourceforge.net/

This project has been registered at SourceForge.net and the development will
be continued there. You can get the summary/status of the project and how it's
going, from :
http://sourceforge.net/projects/kirc/

There are also some foums dedicated to k-IRC:
http://sourceforge.net/forum/?group_id=91060



8. Problems/Bug Reports & Feature Requests
-------------------------------------------
Please feel free to send me your comments, questions & ideas as well as
the possible bugs you may get into. Helps are always welcome!
But first, please check the ToDo and Bugs list before contacting me. Maybe
the feature(s)/bug(s) you're going to request/report are already listed there.

You can report the bugs and problems as well as your feature requests via
two methods. The first by directly contacting me (see contact info) and the
second to use k-IRC bug tracker at SourceForge.net where can be found at :
http://sourceforge.net/tracker/?group_id=91060



9. Contact Information
-----------------------
You can contact me directly at :
- Armond555@yahoo.com
- Armond333@yahoo.com

Or visit k-IRC home page at :
      http://kirc.sourceforge.net/



	*** Thanks for trying k-IRC ;-) ***
	***    Have Happy Chatting!    ***
