From 332f1b5c403c5e8c5f9aff8dbb00989c5609dd26 Mon Sep 17 00:00:00 2001
From: Robert Alessi <alessi@robertalessi.net>
Date: Wed, 30 Mar 2016 15:54:25 +0200
Subject: added README.tex; cleaning up

---
 README.tex | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 README.tex

(limited to 'README.tex')

diff --git a/README.tex b/README.tex
new file mode 100644
index 0000000..916eb0e
--- /dev/null
+++ b/README.tex
@@ -0,0 +1,83 @@
+\documentclass{article}
+
+\usepackage{fontspec,luatextra}
+
+\title{The arabluatex package}
+\author{Robert Alessi}
+\usepackage{hyperref}
+
+\begin{document}
+\maketitle
+
+\section*{Overview}
+\label{sec:overview}
+This package provides for \LuaLaTeX\ an Arab{\TeX}-like interface to
+generate Arabic writing from an \textsc{ascii} transliteration. It is
+particularly well-suited for complex documents such as technical
+documents or critical editions where a lot of left-to-right commands
+intertwine with Arabic writing. arabluatex is able to
+process any Arab\TeX\ input notation. Its output can be set in the
+same modes of vocalization as Arab\TeX, or in different roman
+transliterations. It further allows many typographical refinements. It
+will eventually interact with some other packages yet to come to
+produce from \verb|.tex| source files, in addition to printed books,
+\texttt{TEI xml} compliant critical editions and/or lexicons that can
+be searched, analyzed and correlated in various ways.
+
+\section*{License and disclamer}
+Copyright \textcopyright\ 2016  Robert Alessi
+
+\addcontentsline{toc}{section}{License and disclamer} Please send
+error reports and suggestions for improvements to Robert Alessi:
+\begin{itemize}
+\item email: \url{alessi@robertalessi.net}
+\item website: \url{http://www.robertalessi.net/arabluatex}
+\end{itemize}
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+
+This release of arabluatex consists of the following
+source files:
+\begin{itemize}
+\item \verb|arabluatex.ins|
+\item \verb|arabluatex.dtx|
+\item \verb|arabluatex.lua|
+\item \verb|arabluatex_voc.lua|
+\item \verb|arabluatex_fullvoc.lua|
+\item \verb|arabluatex_novoc.lua|
+\item \verb|arabluatex_trans.lua|
+\item \verb|arabluatex.bib|
+\end{itemize}
+
+\section*{Installation}
+\label{sec:installation}
+\begin{enumerate}
+\item run \verb+lualatex arabluatex.ins+ to produce the
+  \verb+arabluatex.sty+ file;
+\item To finish the installation you have to move the following files
+into a directory searched by LaTeX. See the FAQ on CTAN at
+/help/uk-tex-faq for more on this:
+\begin{itemize}
+\item \verb|arabluatex.sty|
+\item \verb|arabluatex.lua|
+\item \verb|arabluatex_voc.lua|
+\item \verb|arabluatex_fullvoc.lua|
+\item \verb|arabluatex_novoc.lua|
+\item \verb|arabluatex_trans.lua|
+\end{itemize}
+\end{enumerate}
+
+\end{document}
\ No newline at end of file
-- 
cgit v1.2.3