[README FILE - START]

Copyright (C) 2006 Idan Nof

0. Contents of this file:

	1. Quick Summary
	2. License
	3. Supported platforms
	4. How to compile
	5. Files in this package
	6. Program description
	7. Technical issues
	8. Notes
	9. Acknowledgments
	10. Plans for future versions
	11. Release history

1. Quick Summary

        Name    : chat
        Version : 0.1a
	Author  : Idan Nof [idannof@hotmail.Removethis.com]
	Homepage: http://www.geocities.com/idannof/    (case sensitive)
        Excerpt : a TCP/IP, client-server, multiuser chatting program.

	Usage   :
                  Start the following Java processes using your favorite
                  Java Environment:

                  Server process - in Server/Server
                  Client process - in Client/Client

                  After a successfull connection between a client and
                  a server, create or join a room using the syntax:

                  open <SessionName>

2. License 

	Copyright (C) 2006 Idan Nof
	(See attached file "copying" and/or visit "www.gnu.org" )

	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., 675 Mass Ave, Cambridge, MA 02139, USA.
	"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.

3. Supported platforms

	You may go ahead and try to run under any Java environment, but
	'chat' was tested to compile and run under the following platforms-

	* Sun JRE 1.3.1_17/Windows 98 SE, Windows XP
	* Evidence exists for working under Ubuntu

4. How to compile

	a) Instructions For 'gcc':
	   - Build	: use 'make all'
	   - Clean	: use 'make clean'

5. Files in this package

	readme.txt      this file
	copying         copying conditions: GPL license

	startServer.bat a DOS batch file to initiate the server process
	startClient.bat a DOS batch file to initiate the client process

	*.java          source code	
	*.class         compiled byte code

6. Program description

	The chat program is divided into two parts;

	A server process, which listens on a given port for
	incoming requests from client processes.

	A client process, which initiates connections to a server
	and creates or joines a chat session room.

7. Technical issues

	a) The program supports several sessions and several users
           in each session.

8. Notes

	-> Please report bugs/suggestions!

9. Acknowledgments

        * The excellent book 'Thinking in Java' by Bruce Eckel
          [http://www.mindview.net/]

        * Liran Katzir [http://www.cs.technion.ac.il/~lirank/] for some of
          the design of this software

	* D.J. Murdoch [http://www.murdoch-sutherland.com/] of which I took
	  the outline of this Readme file


10. Plans for future versions 

        - Some method to coordinate automatic connection when using dynamic
          IP addresses, by email or so.

11. Release history (YYYY-MM-DD)

        2006-09-19 : Version 0.1a
		cosmetical cleanups, first public version.

	2006-03-03 : Version 0.1
		A more-or-less stable state

        2006-02-02: Project Started

[README FILE - END]
