*Description ----------------------------------------------------------------

Popup is an interactive learning aid for one-to-one word mappings. The
special thing about it is that it can use cmafi'e (part of Richard
Curnows jbofi'e, http://www.rrbcurnow.freeuk.com/jbofihe) to extract
the lojban (a constructed language with an unambigously parseable
grammar, http://www.lojban.org) vocabulary from an X selection.

*Dependencies ---------------------------------------------------------------

Popup uses GNUstep, a framework mostly conforming to the OPENSTEP
specification. GNUstep can be retrieved from
http://www.gnustep.org . Since MacOS X also contains an OPENSTEP
conforming API, Popup should be easily portable to MacOS X. The BRandom
class would have to be given some attention though. 

Because Popup is written in Objective-C, you also need a capable compiler.

*Compilation ----------------------------------------------------------------

Once you have a working GNUstep environment a simple 

	make && make install 

should do it.

*convstack ------------------------------------------------------------------

Included in this distribution is the 'convstack' tool. It can be found in the convstack directory. With version 0.4, the format of the CardStack file has changed. The extension also changed from .dat to .cstack. This tool can be used to convert old card stacks to the new format. It is used like this:

convstack OldStack.dat NewStack.cstack

There is no provisions for wildcards, so if you have a directory full of stacks, you'll need to convert each one individually. It does not erase the original file. 

If you run into problems, it is  probably because the file contains non-ascii characters that are not escaped (eg \u0e0a). In this case the file will first need to be converted using the cvtenc tool included with GNUstep. 

"make install" will compile it, and install it in your gnustep user directory. You don't have to become root.

*CardStacks -----------------------------------------------------------------

In the CardStacks directory, you will find a selection of card stacks to test things with. In the future I hope this directory will contain some default stacks that are more useful.

*Contributing ---------------------------------------------------------------

Refer to the TODO file for the current development agenda. All bugs, suggestions, contributions welcome. I realize that although the progam is usable it still needs work and testing.

Localizable.strings files can be generated like this:

cd Resources
mkdir <language>.lproj
make_strings -L "<language>" ../*.m

make_strings will log some errors, but the Localizable.strings file will be there when its done. Good documentation on make_strings, and what to do with the Localizable.strings files it generates, can be found in the GNUstep source distribution in base/Tools/make_strings/Using.txt.

*Known Bugs --------------------------------------------------------------

Some combinations of opening, closing, and taking quizes will cause the app to slow down, and things to be drawn funny. It seems fairly random to me. There are probably some memory management problems in Popup.app, but I'm not sure where.

The Parse Selection functionality has been disabled for this release.

When using the search function, the currently selected word will remain selected. This seems to be a bug in updating the display of NSTableViews, as it is actually not selected just still highlighted.

*Credits -------------------------------------------------------------------

Popup is written by Bjorn Gohla and Rob Burns
Thanks to Marcus (I don't know your last name) for the German localization.

*Licencing ------------------------------------------------------------------

Popup is released under the GNU General Public License 2.0. See LICENCE.txt.  

END
