first commit

CS2335/lab4/P3_README.txt

@@ -0,0 +1,86 @@
+CS2335 - Spring 2004                                         Lab 4 - NetPaint
+=============================================================================
+                            PART 3 -- README
+=============================================================================
+DIRECTIONS:
+  This form must be filled out and submitted with the rest of your files for
+  Part 1. For each item replace the underscore characters ('_') with the
+  proper information. If you need more lines than those shown, feel free to
+  add them.
+=============================================================================
+
+1. Team Members:
+     Name:  Vladimir Urazov
+     GTNum: gtg308i
+
+     Name:  Daniyar Zhanbekov
+     GTNum: gtg563g
+
+2. Put an 'X' Indicating All Extra Credit Options Completed:
+     [X] Amazing UI (All teams are are eligible for this one.)
+     [ ] Image File Transfer
+     [X] Super Undo
+     [X] Emoticons
+     [X] File Saving/Loading from XML
+
+3. Compilation Instructions:
+
+     To compile the program, one can simply use the ant build
+     file. The command to build the sources into classes is "ant
+     build".
+
+4. Instructions for Running the Program:
+
+     There are two parts to the program - the client and the
+     server. Both can be run using the ant build file, or one of the
+     jar files. In the buildfile, one can use the targets "run_server"
+     and "run_client" to run the server and the client
+     respectively. Also, there is a target named "jar", which allows
+     one to create two jar files - one for the server, and one for the
+     client. Each of those jar files can be executed to run the
+     respective part of the program.
+
+
+5. Known Bugs:
+
+     The only thing worth mentioning here is that there are some fonts
+     under RedHat that don't seem to work. For instance, the font
+     named "Cursor" will not display anything if it is chosen with the
+     Text Insertion tool. Also, when working on the same session from
+     different operating systems (i.e. some cliens are connected from
+     a Linux box, and some others from a Windows box), the fonts will
+     sometimes not match if one of the users selects a font that is
+     not present on another machine. The text still displays, the
+     images on each machine aren't exactly the same.
+
+     Also, a minor annoyance is that the "maximize" button of the main
+     window does not seem to function.
+
+6. Testing/Development Environments (Include OS):
+     [REMINDER: This lab will be graded on the RedHat systems in
+                the States Lab.]
+
+     Windows XP / EMACS and RedHat / EMACS
+
+7. Short Description of File Format for Saved Files:
+
+     The session is saved in XML files. The schema is rather simple:
+     the root element is called "session", and within it are elements
+     which are named the same as the classes of different network
+     messages. Each such element contains different nested elements
+     which correspond to the properties of that tool. So, for
+     instance, line elements would have the coordinates of the line
+     ends, as well as the color in which the line should be drawn as
+     nested elements.
+
+8. Comments:
+
+     See the help.html for program usage. This is also accessible
+     through the in-program help system.
+
+     We also implemented some features that weren't required, but
+     weren't suggested by the extra credit section of the requirements
+     document either. Such things include the ability to insert
+     differently styled text - in bold or italics, etc.
+
+