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

..03-May-2022-

.github/H06-Dec-2021-428356

build-aux/H06-Dec-2021-2920

contrib/H06-Dec-2021-621482

doc/H03-May-2022-4,1353,368

extra/generate-display-names/H06-Dec-2021-640603

gnulib/H03-May-2022-12,3509,458

liblouis/H03-May-2022-15,92313,349

m4/H07-May-2022-

man/H03-May-2022-6945

python/H03-May-2022-989815

tables/H07-May-2022-537,556525,604

tests/H03-May-2022-1,326,3611,321,008

tools/H03-May-2022-25,55718,724

windows/H03-May-2022-14278

.clang-formatH A D06-Dec-20212.5 KiB9089

.dir-locals.elH A D06-Dec-202180 54

.dockerignoreH A D06-Dec-20215.7 KiB335300

.gitignoreH A D06-Dec-20216 KiB337302

ANNOUNCEMENTH A D06-Dec-20213.6 KiB13092

AUTHORSH A D06-Dec-20218.7 KiB238210

COPYINGH A D06-Dec-202134.3 KiB675553

COPYING.LESSERH A D06-Dec-202125.9 KiB503418

ChangeLogH A D06-Dec-202150.6 KiB1,6551,201

DockerfileH A D06-Dec-2021637 3024

Dockerfile.win32H A D06-Dec-20212.6 KiB8372

Dockerfile.win64H A D06-Dec-20212.2 KiB7060

DoxyfileH A D06-Dec-2021104.7 KiB2,4541,899

HACKINGH A D06-Dec-202115.1 KiB458351

License.mdH A D06-Dec-202125.8 KiB505420

Makefile.amH A D03-May-20221.1 KiB4127

NEWSH A D06-Dec-2021114.4 KiB2,7762,454

READMEH A D06-Dec-20214.9 KiB11487

README.mdH A D06-Dec-20214.9 KiB11487

README.windowsH A D06-Dec-20211.4 KiB3123

TODOH A D06-Dec-20212.6 KiB7251

autogen.shH A D03-May-20221.4 KiB4211

configure.acH A D06-Dec-20216.9 KiB238204

liblouis.pc.inH A D06-Dec-2021283 1311

libyaml_mingw.patchH A D06-Dec-2021704 2724

README

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

README.md

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

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