Author: christian.egli@xxxxxxxxxxxxxx Date: Tue Dec 23 01:01:36 2008 New Revision: 49 Modified: trunk/README Log: Added an intro section to the README that highlights the main features. Modified: trunk/README ============================================================================== --- trunk/README (original) +++ trunk/README Tue Dec 23 01:01:36 2008 @@ -1,3 +1,24 @@ +INTRODUCTION + +Liblouis is an open-source braille translator and back-translator. It +features support for computer and literary braille, supports +contracted and uncontracted translation for many, many languages +(Arabic, Armenian, Bulgarian, Chinese, Croatian, Czech, Danish, Dutch, +English, Esperanto, Estonian, Finish, French, Gaelic, German, Greek, +Icelandic, Italian, Lithuanian, Norwegian, Polish, Portuguese, +Romanian, Russian, Slovakian, Spanish, Swedish, Turkish, Vietnamese, +Welsh) and has support for hyphenation. New languages can easily be +added through tables that support a rule- or dictionary based +approach. Included are also tools for testing and debugging tables. +Liblouis also supports math braille (Nemeth and Marburg). The +formatting of braille is provided by the companion project +liblouisxml. + +Liblouis is based on the translation routines in the BRLTTY +screenreader for Linux. It has, however, gone far beyond these +routines. It is named in honor of Louis Braille. In Linux and Mac OSX +it is a shared library, and in Windows it is a DLL. + DOCUMENTATION For documentation, see liblouis-guide.html and liblouis-guide.txt in the For a description of the software and to download it go to http://www.jjb-software.com