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