aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 17 insertions, 17 deletions
diff --git a/README.md b/README.md
index 5cd4118..908a6ba 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,32 @@
1--- 1---
2author: 2author:
3- Robert Alessi 3- Robert Alessi
4title: 'The arabluatex package README file' 4title: 'The arabluatex package -- README file'
5--- 5---
6 6
7\maketitle
7Overview 8Overview
8======== 9========
9 10
10This package provides for [LuaLaTeX](http://luatex.org) an 11This package provides for [LuaLaTeX](http://luatex.org) an
11[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic 12[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic
12writing from an <span style="font-variant:small-caps;">ascii</span> 13writing from an [ascii]{.smallcaps} transliteration. It is particularly
13transliteration. It is particularly well-suited for complex documents 14well-suited for complex documents such as technical documents or
14such as technical documents or critical editions where a lot of 15critical editions where a lot of left-to-right commands intertwine with
15left-to-right commands intertwine with Arabic writing. arabluatex is 16Arabic writing. arabluatex is able to process any ArabTeX input
16able to process any ArabTeX input notation. Its output can be set in the 17notation. Its output can be set in the same modes of vocalization as
17same modes of vocalization as ArabTeX, or in different roman 18ArabTeX, or in different roman transliterations. It further allows many
18transliterations. It further allows many typographical refinements. It 19typographical refinements. It will eventually interact with some other
19will eventually interact with some other packages yet to come to produce 20packages yet to come to produce from `.tex` source files, in addition to
20from `.tex` source files, in addition to printed books, `TEI xml` 21printed books, `TEI xml` compliant critical editions and/or lexicons
21compliant critical editions and/or lexicons that can be searched, 22that can be searched, analyzed and correlated in various ways.
22analyzed and correlated in various ways.
23 23
24License and disclamer 24License and disclamer
25===================== 25=====================
26 26
27ArabLuaTeX Processing ArabTeX notation under LuaLaTeX 27ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
28 28
29Copyright ⓒ 20162020 Robert Alessi 29Copyright ⓒ 2016--2020 Robert Alessi
30 30
31Please send error reports and suggestions for improvements to Robert 31Please send error reports and suggestions for improvements to Robert
32Alessi: 32Alessi:
@@ -49,7 +49,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
49Public License for more details. 49Public License for more details.
50 50
51You should have received a copy of the GNU General Public License along 51You should have received a copy of the GNU General Public License along
52with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;. 52with this program. If not, see \<http://www.gnu.org/licenses/\>.
53 53
54This release of arabluatex consists of the following source files: 54This release of arabluatex consists of the following source files:
55 55
@@ -70,7 +70,7 @@ This release of arabluatex consists of the following source files:
70License applicable to the documentation 70License applicable to the documentation
71--------------------------------------- 71---------------------------------------
72 72
73Copyright ⓒ 20162020 Robert Alessi 73Copyright ⓒ 2016--2020 Robert Alessi
74 74
75The documentation file `arabluatex.pdf` that is generated from the 75The documentation file `arabluatex.pdf` that is generated from the
76`arabluatex.dtx` source is licensed under the Creative Commons 76`arabluatex.dtx` source is licensed under the Creative Commons
@@ -104,7 +104,7 @@ Installation
104 104
1053. Additionally, those who use emacs with AUCTeX may copy 1053. Additionally, those who use emacs with AUCTeX may copy
106 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory. 106 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory.
107 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX. 107 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX.
108 108
109Development, Git Repository 109Development, Git Repository
110=========================== 110===========================