diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 41 |
1 files changed, 23 insertions, 18 deletions
@@ -1,27 +1,31 @@ | |||
1 | --- | ||
2 | author: | ||
3 | - Robert Alessi | ||
4 | title: 'The arabluatex package – README file' | ||
5 | --- | ||
6 | |||
1 | Overview | 7 | Overview |
2 | ======== | 8 | ======== |
3 | 9 | ||
4 | This package provides for LuaLaTeX an Arab<span>TeX</span>-like | 10 | This package provides for [LuaLaTeX](http://luatex.org) an |
5 | interface to generate Arabic writing from an <span | 11 | [ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic |
6 | style="font-variant:small-caps;">ascii</span> transliteration. It is | 12 | writing from an <span style="font-variant:small-caps;">ascii</span> |
7 | particularly well-suited for complex documents such as technical | 13 | transliteration. It is particularly well-suited for complex documents |
8 | documents or critical editions where a lot of left-to-right commands | 14 | such as technical documents or critical editions where a lot of |
9 | intertwine with Arabic writing. arabluatex is able to process any | 15 | left-to-right commands intertwine with Arabic writing. arabluatex is |
10 | ArabTeX input notation. Its output can be set in the same modes of | 16 | able to process any ArabTeX input notation. Its output can be set in the |
11 | vocalization as ArabTeX, or in different roman transliterations. It | 17 | same modes of vocalization as ArabTeX, or in different roman |
12 | further allows many typographical refinements. It will eventually | 18 | transliterations. It further allows many typographical refinements. It |
13 | interact with some other packages yet to come to produce from `.tex` | 19 | will eventually interact with some other packages yet to come to produce |
14 | source files, in addition to printed books, `TEI xml` compliant critical | 20 | from `.tex` source files, in addition to printed books, `TEI xml` |
15 | editions and/or lexicons that can be searched, analyzed and correlated | 21 | compliant critical editions and/or lexicons that can be searched, |
16 | in various ways. | 22 | analyzed and correlated in various ways. |
17 | 23 | ||
18 | License and disclamer | 24 | License and disclamer |
19 | ===================== | 25 | ===================== |
20 | 26 | ||
21 | Copyright ⓒ 2016 Robert Alessi | 27 | Copyright ⓒ 2016 Robert Alessi Please send error reports and suggestions |
22 | 28 | for improvements to Robert Alessi: | |
23 | Please send error reports and suggestions for improvements to Robert | ||
24 | Alessi: | ||
25 | 29 | ||
26 | - email: [alessi@robertalessi.net](alessi@robertalessi.net) | 30 | - email: [alessi@robertalessi.net](alessi@robertalessi.net) |
27 | 31 | ||
@@ -62,7 +66,8 @@ This release of arabluatex consists of the following source files: | |||
62 | Installation | 66 | Installation |
63 | ============ | 67 | ============ |
64 | 68 | ||
65 | 1. run `lualatex arabluatex.ins` to produce the `arabluatex.sty` file; | 69 | 1. run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty` |
70 | file; | ||
66 | 71 | ||
67 | 2. To finish the installation you have to move the following files into | 72 | 2. To finish the installation you have to move the following files into |
68 | a directory where LaTeX can find them. See the FAQ on `tex.ac.uk` at | 73 | a directory where LaTeX can find them. See the FAQ on `tex.ac.uk` at |