aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md83
1 files changed, 83 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad8cec4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
1Overview {#sec:overview .unnumbered}
2========
3
4This package provides for LuaLaTeX an Arab<span>TeX</span>-like
5interface to generate Arabic writing from an <span
6style="font-variant:small-caps;">ascii</span> transliteration. It is
7particularly well-suited for complex documents such as technical
8documents or critical editions where a lot of left-to-right commands
9intertwine with Arabic writing. arabluatex is able to process any
10ArabTeX input notation. Its output can be set in the same modes of
11vocalization as ArabTeX, or in different roman transliterations. It
12further allows many typographical refinements. It will eventually
13interact with some other packages yet to come to produce from `.tex`
14source files, in addition to printed books, `TEI xml` compliant critical
15editions and/or lexicons that can be searched, analyzed and correlated
16in various ways.
17
18License and disclamer {#license-and-disclamer .unnumbered}
19=====================
20
21Copyright ⓒ 2016 Robert Alessi
22
23Please send error reports and suggestions for improvements to Robert
24Alessi:
25
26- email: [alessi@robertalessi.net](alessi@robertalessi.net)
27
28- website: <http://www.robertalessi.net/arabluatex>
29
30This program is free software; you can redistribute it and/or modify it
31under the terms of the GNU General Public License as published by the
32Free Software Foundation; either version 2 of the License, or (at your
33option) any later version.
34
35This program is distributed in the hope that it will be useful, but
36WITHOUT ANY WARRANTY; without even the implied warranty of
37MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
38Public License for more details.
39
40You should have received a copy of the GNU General Public License along
41with this program; if not, write to the Free Software Foundation, Inc.,
4259 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
43
44This release of arabluatex consists of the following source files:
45
46- `arabluatex.ins`
47
48- `arabluatex.dtx`
49
50- `arabluatex.lua`
51
52- `arabluatex_voc.lua`
53
54- `arabluatex_fullvoc.lua`
55
56- `arabluatex_novoc.lua`
57
58- `arabluatex_trans.lua`
59
60- `arabluatex.bib`
61
62Installation {#sec:installation .unnumbered}
63============
64
651. run `lualatex arabluatex.ins` to produce the `arabluatex.sty` file;
66
672. To finish the installation you have to move the following files into
68 a directory searched by LaTeX. See the FAQ on CTAN at
69 /help/uk-tex-faq for more on this:
70
71 - `arabluatex.sty`
72
73 - `arabluatex.lua`
74
75 - `arabluatex_voc.lua`
76
77 - `arabluatex_fullvoc.lua`
78
79 - `arabluatex_novoc.lua`
80
81 - `arabluatex_trans.lua`
82
83