arabluatex/README.tex

% The arabluatex package -- README file
% Robert Alessi
% January 29, 2023
\documentclass{article}

\usepackage{fontspec}

\title{The arabluatex package -- README file}
\author{Robert Alessi}
\usepackage{hyperref}
\hypersetup{pdftitle={The arabluatex package -- README file},
  pdfauthor={Robert Alessi}}

\begin{document}
\maketitle

\section*{Overview}
\label{sec:overview}
This package provides for \href{https://luatex.org}{Lua\LaTeX}
an \href{https://ctan.org/pkg/arabtex}{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 can also operate
with the \href{https://ctan.org/pkg/ekdosis}{ekdosis} package 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}
ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX

Copyright ⓒ  2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023
Robert Alessi <\verb|alessi@robertalessi.net|>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Please send error reports and suggestions for improvements to Robert
Alessi:
\begin{itemize}
\item email: \href{mailto:alessi@robertalessi.net}{alessi@robertalessi.net}
\item website: \url{https://sr.ht/~ralessi/arabluatex}
\item comments, feature requests, bug reports:
  \url{https://todo.sr.ht/~ralessi/arabluatex}
\end{itemize}

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|
\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 where LaTeX can find them. See the FAQ on
  \verb|texfaq.org| at
  \url{https://texfaq.org/FAQ-inst-wlcf} for more on this:
\begin{itemize}
\item \verb|arabluatex.sty|
\item \verb|arabluatex-patch.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}
\item Additionally, those who use emacs with AUC\TeX\ may copy
  \verb|arabluatex.el| to their \verb|~/.emacs.d/auctex/auto| local
  directory.  This will enable the appropriate hooks for ArabLua\TeX\
  in AUC\TeX.
\end{enumerate}

\section{Development, Git Repository}
\label{sec:devel-git-repos}
\subsection*{Browse the code}
\label{sec:browse-code}

You can browse ArabLua\TeX\ repository on the web:
\url{http://git.robertalessi.net/arabluatex}\\
or\\
\url{https://sr.ht/~ralessi/arabluatex}

From this page, you can download all the releases of ArabLua\TeX. For
instructions on how to install ArabLua\TeX, please see above.

\subsection*{Comments, Feature requests, Bug Reports}
\label{sec:comm-feat-requ}
\url{https://todo.sr.ht/~ralessi/arabluatex}

\subsection*{Download the repository}
\label{sec:download-repository}
ArabLua\TeX\ development is facilitated by git, a distributed version
control system. You will need to install git (most Unix/Linux
distributions package it in their repositories).

Use this command to download the repository
\begin{verbatim}
git clone https://git.sr.ht/~ralessi/arabluatex
\end{verbatim}

A new directory named arabluatex will have been created, containing
ArabLuaTeX.

\subsection*{Git hosting}
\label{sec:git-hosting}
Make an account on \url{https://sr.ht} and navigate (while logged in)
to \url{https://git.sr.ht/~ralessi/arabluatex}. Click \emph{Clone repo
  to your account} and you will have in your account your own
repository of \verb|arabluatex| where you will be able to make
whatever changes you like to.

\end{document}