= rcrossword

* FIX (url)

== DESCRIPTION:

Dieses Projekt besteht zur Zeit im Wesentlichen aus der Klasse Grid, welche
grundlegende und allgemeine Methoden zum Arbeiten mit einer Kreuzwortraetsel-
Matrix zur Verfuegung stellt, sowie der Klasse Generator, welche die Algorithmen
zur Verfuegung stellt, mit denen ein Kreuzwortraetsel erstellt wird.

Aus den Test-Skripts ist ersichtlich, wie diese Klassen verwendet werden
koennen.

Die zentrale Methode zum Erzeugen eines Raetsel ist die Methode #generate.
Diese bekommt eine Liste mit Worten und Hinweistexten, und weiteren Parametern
uebergeben und versucht, daraus ein Raetsel zu generieren.

Momentan ist diese Methode noch nicht der Weisheit letzter Schluss. Sie funktioniert,
ist aber weder effizient noch wirklich gut (d. h. die Positionierung von Worten
muss noch besser werden).

Einige Verbesserungen sind schon angedacht, aber noch nicht implemetiert:
- Einfuegeposition nich rein zufaellig sondern nur an den Stellen, die noch
frei sind. D. h. man muesste irgendwie eine Liste von noch freien Positionen
verwalten
- Zur Zeit werden Worte aus der Liste noch mehrfach eingesetzt. Dies ist ein
eher triviales Problem und hat auf den grundlegenden Algorithmus keine
Auswirkungen. Man muss einfach nur das einmal eingesetzt Wort aus der Liste
entfernen, so dass es nicht mehrfach verwendet wird.
- Worte sollten nicht zufaellig plaziert werden, sondern nach einem intelligenteren
Algorithmus, der versucht, moeglichst Kreuzungen mit anderen Worten zu nutzen

Gff. wird es einen Mechanismus geben, um innerhalb des Programms mit
unterschiedlichen generate-Methoden zu arbeiten, bzw. zwischen ihnen umzuschalten.
Das würde bedeuten, es gibt mehrere Generator#generate Methoden, z.B. von
verschiedenen Leuten implementiert, um daraus fuer die Zukunft die beste
Strategie fuer das Programm auszuwaehlen.

Beim erfolgreichen Generieren wird daraus eine HTML-Datei zum bequemeren
Anschauen im Browser erzeugt. Weitere Methoden
ein Raetsel auszugeben sind geplant - beispielsweise waere eine LaTeX-Datei oder
eine XML-Datei moeglich.

== FEATURES/PROBLEMS:

* FIX (list of features or problems)

== SYNOPSIS:

FIX (code sample of usage)

== REQUIREMENTS:

* FIX (list of requirements)

== INSTALL:

* FIX (sudo gem install, anything else)

== LICENSE:

(The MIT License)

Copyright (c) 2008 FIXME full name

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.