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