• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..16-Feb-2021-

.travis/H16-Feb-2021-327209

build-aux/H16-Feb-2021-2920

contrib/H16-Feb-2021-434356

doc/H16-Feb-2021-3,8423,136

extra/generate-display-names/H16-Feb-2021-509487

gnulib/H16-Feb-2021-12,3509,458

liblouis/H16-Feb-2021-14,98512,575

m4/H16-Feb-2021-

man/H16-Feb-2021-6945

python/H16-Feb-2021-671561

tables/H16-Feb-2021-503,027492,351

tests/H16-Feb-2021-1,285,5531,280,686

tools/H16-Feb-2021-25,43818,633

windows/H16-Feb-2021-14278

.clang-formatH A D16-Feb-20212.5 KiB9089

.dir-locals.elH A D16-Feb-202180 54

.dockerignoreH A D16-Feb-20215 KiB308279

.gitignoreH A D16-Feb-20215.9 KiB335300

.travis.ymlH A D16-Feb-20212.6 KiB8068

ANNOUNCEMENTH A D16-Feb-20217.3 KiB193155

AUTHORSH A D16-Feb-20217.8 KiB220192

COPYINGH A D16-Feb-202134.3 KiB675553

COPYING.LESSERH A D16-Feb-202125.9 KiB503418

DockerfileH A D16-Feb-2021637 3024

Dockerfile.devH A D16-Feb-2021770 3022

DoxyfileH A D16-Feb-2021104.7 KiB2,4541,899

HACKINGH A D16-Feb-202115.9 KiB474365

License.mdH A D16-Feb-202125.8 KiB505420

Makefile.amH A D16-Feb-20212.4 KiB6550

NEWSH A D16-Feb-202185.5 KiB2,0611,808

READMEH A D16-Feb-20214.7 KiB11285

README.mdH A D16-Feb-20214.7 KiB11285

README.windowsH A D16-Feb-20211.4 KiB3123

TODOH A D16-Feb-20212.6 KiB7251

autogen.shH A D16-Feb-20211.4 KiB4211

configure.acH A D16-Feb-20216.4 KiB222190

liblouis.pc.inH A D16-Feb-2021283 1311

README

1# Introduction
2
3[![Build Status](https://travis-ci.org/liblouis/liblouis.svg?branch=master)](https://travis-ci.org/liblouis/liblouis)
4
5Liblouis is an open-source braille translator and back-translator
6named in honor of [Louis Braille][]. It features support for computer
7and literary braille, supports contracted and uncontracted translation
8for [many languages][] and has support for hyphenation. New languages
9can easily be added through tables that support a rule- or dictionary
10based approach. Tools for testing and debugging tables are also
11included. Liblouis also supports math braille (Nemeth and Marburg).
12
13Liblouis has features to support screen-reading programs. This has led
14to its use in two open-source screenreaders, [NVDA][] and [Orca][]. It
15is also used in some commercial assistive technology applications for
16example by [ViewPlus][].
17
18Liblouis is based on the translation routines in the [BRLTTY][]
19screenreader for Linux. It has, however, gone far beyond these
20routines. In Linux and Mac OSX it is a shared library, and in Windows
21it is a DLL.
22
23Liblouis is free software licensed under the [GNU LGPLv2.1+][] (see
24the file COPYING.LESSER).
25
26The command line tools, are licensed under the [GNU GPLv3+][] (see the
27file COPYING).
28
29# Documentation
30
31For documentation, see the [liblouis documentation][] (either as info
32file, html, txt or pdf) in the doc directory. For examples
33of translation tables, see `en-us-g2.ctb`, `en-us-g1.ctb`,
34`chardefs.cti`, and whatever other files they may include in the
35tables directory. This directory contains tables for many languages.
36The Nemeth files will only work with the sister library
37[liblouisutdml][].
38
39# Installation
40
41After unpacking the distribution tarball from [releases][] go to the directory it creates.
42You now have the choice to compile liblouis for either 16- or 32-bit
43unicode. By default it is compiled for the former. To get 32-bit Unicode
44run configure with `--enable-ucs4`.
45
46After running `./configure` run `make` and then `make install`. You
47must have root privileges for the installation step.
48(For other ways of installation, see the file HACKING)
49
50This will produce the liblouis library and the programs `lou_allround`
51(for testing the library), `lou_checkhyphens`, `lou_checktable` (for
52checking translation tables), `lou_debug` (for debugging translation
53tables), `lou_translate` (for extensive testing of forward and
54backwards translation) and `lou_trace` (for tracing if individual
55translations). For more details see the liblouis documentation.
56
57If you wish to have man pages for the programs you might want to
58install `help2man` before running configure.
59
60If you want to run the test suite with `make check` you should install
61`libyaml` as that will enable extensive tests on the tables. If you
62want to skip those tests you can do so by running `configure --without-yaml`.
63
64# Participating
65
66You can contribute to Liblouis in several different ways:
67
68  - If you have comments, questions, or want to use your knowledge to
69    help others, come join the conversation on either the mailing list
70    or on IRC. You can reach us at liblouis-liblouisxml@freelists.org
71    or in channel #liblouis on irc:irc.oftc.net.
72
73  - To report a problem or request a feature, please file an issue.
74
75  - Of course, we welcome pull requests and patches.
76
77Finally, if you want to see what we have for the future and learn more
78about our release cycles, all this information is detailed on the
79[wiki](https://github.com/liblouis/liblouis/wiki/Release-schedule)
80
81# Release Notes
82
83For notes on the newest and older releases see the file NEWS.
84
85# History
86
87Liblouis was begun in 2002 largely as a business decision by
88[ViewPlus][]. They believed that they could never have good braille
89except as part of an open source effort and knew that John Boyer was
90dying to start just such a project. So ViewPlus did start it on the
91agreement that they would give a small monthly stipend to John Boyer
92that allowed him to pay for sighted assistants. While ViewPlus has not
93contributed much to the coding, it certainly has contributed and
94continues to contribute to liblouis through that support of John
95Boyer.
96
97[Louis Braille]: http://en.wikipedia.org/wiki/Louis_Braille
98[many languages]: https://github.com/liblouis/liblouis/tree/master/tables
99[NVDA]: http://www.nvda-project.org/
100[Orca]: http://live.gnome.org/Orca
101[ViewPlus]: http://www.viewplus.com
102[BRLTTY]: http://mielke.cc/brltty/
103[GNU LGPLv2.1+]: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
104[GNU GPLv3+]: https://www.gnu.org/licenses/gpl.html
105[liblouisutdml]: http://www.liblouis.org/
106[liblouis documentation]: http://www.liblouis.org/documentation/liblouis.html
107[releases]: https://github.com/liblouis/liblouis/releases
108
109<!-- Local Variables: -->
110<!-- mode: markdown -->
111<!-- End: -->
112

README.md

1# Introduction
2
3[![Build Status](https://travis-ci.org/liblouis/liblouis.svg?branch=master)](https://travis-ci.org/liblouis/liblouis)
4
5Liblouis is an open-source braille translator and back-translator
6named in honor of [Louis Braille][]. It features support for computer
7and literary braille, supports contracted and uncontracted translation
8for [many languages][] and has support for hyphenation. New languages
9can easily be added through tables that support a rule- or dictionary
10based approach. Tools for testing and debugging tables are also
11included. Liblouis also supports math braille (Nemeth and Marburg).
12
13Liblouis has features to support screen-reading programs. This has led
14to its use in two open-source screenreaders, [NVDA][] and [Orca][]. It
15is also used in some commercial assistive technology applications for
16example by [ViewPlus][].
17
18Liblouis is based on the translation routines in the [BRLTTY][]
19screenreader for Linux. It has, however, gone far beyond these
20routines. In Linux and Mac OSX it is a shared library, and in Windows
21it is a DLL.
22
23Liblouis is free software licensed under the [GNU LGPLv2.1+][] (see
24the file COPYING.LESSER).
25
26The command line tools, are licensed under the [GNU GPLv3+][] (see the
27file COPYING).
28
29# Documentation
30
31For documentation, see the [liblouis documentation][] (either as info
32file, html, txt or pdf) in the doc directory. For examples
33of translation tables, see `en-us-g2.ctb`, `en-us-g1.ctb`,
34`chardefs.cti`, and whatever other files they may include in the
35tables directory. This directory contains tables for many languages.
36The Nemeth files will only work with the sister library
37[liblouisutdml][].
38
39# Installation
40
41After unpacking the distribution tarball from [releases][] go to the directory it creates.
42You now have the choice to compile liblouis for either 16- or 32-bit
43unicode. By default it is compiled for the former. To get 32-bit Unicode
44run configure with `--enable-ucs4`.
45
46After running `./configure` run `make` and then `make install`. You
47must have root privileges for the installation step.
48(For other ways of installation, see the file HACKING)
49
50This will produce the liblouis library and the programs `lou_allround`
51(for testing the library), `lou_checkhyphens`, `lou_checktable` (for
52checking translation tables), `lou_debug` (for debugging translation
53tables), `lou_translate` (for extensive testing of forward and
54backwards translation) and `lou_trace` (for tracing if individual
55translations). For more details see the liblouis documentation.
56
57If you wish to have man pages for the programs you might want to
58install `help2man` before running configure.
59
60If you want to run the test suite with `make check` you should install
61`libyaml` as that will enable extensive tests on the tables. If you
62want to skip those tests you can do so by running `configure --without-yaml`.
63
64# Participating
65
66You can contribute to Liblouis in several different ways:
67
68  - If you have comments, questions, or want to use your knowledge to
69    help others, come join the conversation on either the mailing list
70    or on IRC. You can reach us at liblouis-liblouisxml@freelists.org
71    or in channel #liblouis on irc:irc.oftc.net.
72
73  - To report a problem or request a feature, please file an issue.
74
75  - Of course, we welcome pull requests and patches.
76
77Finally, if you want to see what we have for the future and learn more
78about our release cycles, all this information is detailed on the
79[wiki](https://github.com/liblouis/liblouis/wiki/Release-schedule)
80
81# Release Notes
82
83For notes on the newest and older releases see the file NEWS.
84
85# History
86
87Liblouis was begun in 2002 largely as a business decision by
88[ViewPlus][]. They believed that they could never have good braille
89except as part of an open source effort and knew that John Boyer was
90dying to start just such a project. So ViewPlus did start it on the
91agreement that they would give a small monthly stipend to John Boyer
92that allowed him to pay for sighted assistants. While ViewPlus has not
93contributed much to the coding, it certainly has contributed and
94continues to contribute to liblouis through that support of John
95Boyer.
96
97[Louis Braille]: http://en.wikipedia.org/wiki/Louis_Braille
98[many languages]: https://github.com/liblouis/liblouis/tree/master/tables
99[NVDA]: http://www.nvda-project.org/
100[Orca]: http://live.gnome.org/Orca
101[ViewPlus]: http://www.viewplus.com
102[BRLTTY]: http://mielke.cc/brltty/
103[GNU LGPLv2.1+]: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
104[GNU GPLv3+]: https://www.gnu.org/licenses/gpl.html
105[liblouisutdml]: http://www.liblouis.org/
106[liblouis documentation]: http://www.liblouis.org/documentation/liblouis.html
107[releases]: https://github.com/liblouis/liblouis/releases
108
109<!-- Local Variables: -->
110<!-- mode: markdown -->
111<!-- End: -->
112

README.windows

1This file describes how to build liblouis.dll That is the only binary
2file needed by someone who wishes to use liblouis in an application. The
3tables are in the tables subdirectory of the liblouis distribution. For
4an overview of liblouis see README.
5
6First, obtain the liblouis source, either by downloading the latest
7tarball or from the Git repository. See HACKING for instructions.
8If you downloaded the tarball, unpack it.
9
10To build liblouis.dll you will need the Microsoft command-line C/C++
11tools. You will also have to set environment variables correctly. You
12can download the Community version of Microsoft Visual Studio, including
13Visual C++, and the Microsoft Windows SDK for free. It has a batch file
14that sets environment variables and then displays a command prompt.
15
16You might have to add the Visual Studio path
17(C:\Program Files (x86)\Microsoft Visual Studio\2017\Community) to the
18"Path" of the environment variables manually.
19
20Next, go to the subdirectory windows. Edit the file configure.mk. If you
21want 32-bit Unicode change the 2 in the line UCS=2 to a 4.
22
23Open the "VS 2017 Developer Command Prompt" from the Start menu and use the
24"cd" command goto the "\liblouis-x.x.x\windows" folder, then type:
25
26nmake /f Makefile.nmake
27
28The directory will contain liblouis.dll and liblouis.lib, along with
29object files. Note that those liblouis.dll and liblouis.lib only are for
3032-bit usage.
31