Update.

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..bfd7ee1
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,87 @@
+This applet is an interactive cross-words grid for web pages. The
+source code is kind of open-source (modified GPL licence). I am fed up
+with commercial sites which used the previous version which was under
+pure GPL licence without giving me any buck. So now, basically you can
+use it on non-profit sites, and you can modify it and distribute it as
+long as you keep the same licence. For any other usage, please contact
+me.
+
+You can use the arrows to move the cursor in the grid. The ENTER key
+changes the cursor mode (horizontal or vertical), the BACKSPACE key
+deletes the characters and the SPACE key shows the definition of the
+word the cursor is on. The Check word button checks if the word the
+cursor is on is correct, and locks the letters if it is, and the Give
+word gives you the solution for the word the cursor is on and also
+lock the letters.
+
+A color code indicates the status of each letter. The black ones have
+no special status, the red ones are those obtained using the "give
+word" button, the green ones were checked before the grid was finished
+using the "check word" button (yeah, this is the beginning of
+cheating), and the blue ones are those found by yourself. The letters
+become red or green as soon as you use the buttons, and blue when you
+type the last letter and all are correct.
+
+The <APPLET> tag contains the parameters CODEBASE wich indicates the
+name of the directory containing the .class files, CODE which
+indicates the name of the main .class file, and WIDTH and HEIGHT wich
+indicate the size of the rectangle containing the applet. The part of
+the HTML file beetween the <APPLET> and the </APPLET> tags is
+displayed by the browser if it can't run Java applications. In
+general, you put there an error message.
+
+Then come the tags <PARAM> that contain the values of the various
+parameters specific of the applet. For this one, you have to precise
+the following ones :
+
+ - BGCOLOR is the color of the background of the gride. It's an
+   integer which value is r*256*256 + v*256 + b where r, v and b are
+   the three color components, normalized beetween 0 and 255.
+
+ - GRIDWIDTH and GRIDHEIGHT contain the number of columns and the
+   number of rows of the gride.
+
+ - CONTENT is a caracter strings containing the solution of the
+   gride. Letter after letter, line after line. The '.' indicates a
+   black square.
+
+ - FONT is the font for the gride.
+
+ - FONTSIZE is the font size for the gride.
+
+ - SMALLFONT is the font for the row/column coordinates.
+
+ - SMALLFONTSIZE is the font size for the row/columns coordinates.
+
+ - CHECKWORDLABEL is the string to put in the button used to check the
+   word at the cursor's location. If this parameter is not specified,
+   the button does not appear.
+
+ - GIVEWORDLABEL is the string to put in the button used to give the
+   word at the cursor's location. If this parameter is not specified,
+   the button does not appear.
+
+ - DEFINITIONS contains the definitions of the words of the grid. This
+   is optional and the definition-area will be activated only if this
+   parameter is given. This string first indicates the size of the
+   definition area, and then the word definitions, each of them
+   starting with the coordinates of the first character of the word in
+   the grid. See the example for the exact syntax.
+
+So, for the gride above for instance, I have in my HTML file the
+following lines (my .class files are in a class/ directory) :
+
+<APPLET CODEBASE="class" CODE="Words.class" WIDTH=400 HEIGHT=200>
+<PARAM NAME="BGCOLOR" VALUE="15724527">
+<PARAM NAME="GRIDWIDTH" VALUE="4">
+<PARAM NAME="GRIDHEIGHT" VALUE="4">
+<PARAM NAME="CONTENT" VALUE="bu.aetret..relle">
+<PARAM NAME="FONT" VALUE="Courier">
+<PARAM NAME="FONTSIZE" VALUE="24">
+<PARAM NAME="SMALLFONT" VALUE="Courier">
+<PARAM NAME="SMALLFONTSIZE" VALUE="20">
+<PARAM NAME="CHECKWORDLABEL" VALUE="Check word">
+<PARAM NAME="GIVEWORDLABEL" VALUE="Give word">
+<PARAM NAME="DEFINITIONS" VALUE="20x4/horizontal/a1:Ne coulera plus/b1:Une bonne question/d1:Pas lui/vertical/a1:Elle fait l'homme/a2:Pas besoin d'être comme a pour ne plus trouver cette clef/a4:Ainsi, il respire mieux">
+<STRONG>You need a Java-compliant WWW browser with java turned on<STRONG>
+</APPLET>