diff options
Diffstat (limited to 'Master/texmf-dist/source/lualatex/arabluatex/README.tex')
-rw-r--r-- | Master/texmf-dist/source/lualatex/arabluatex/README.tex | 99 |
1 files changed, 71 insertions, 28 deletions
diff --git a/Master/texmf-dist/source/lualatex/arabluatex/README.tex b/Master/texmf-dist/source/lualatex/arabluatex/README.tex index 916eb0e2a5f..982cddb2411 100644 --- a/Master/texmf-dist/source/lualatex/arabluatex/README.tex +++ b/Master/texmf-dist/source/lualatex/arabluatex/README.tex @@ -1,53 +1,63 @@ +% The arabluatex package -- README file +% Robert Alessi +% March 5, 2016 \documentclass{article} \usepackage{fontspec,luatextra} +\usepackage{libertine} -\title{The arabluatex package} +\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 \LuaLaTeX\ an Arab{\TeX}-like interface to +This package provides for \href{http://luatex.org}{Lua\LaTeX} an +\href{http://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 -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. +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 +ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX -\addcontentsline{toc}{section}{License and disclamer} Please send -error reports and suggestions for improvements to Robert Alessi: +Copyright ⓒ 2016 Robert Alessi + +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} +\item comments, feature requests, bug reports: + \url{https://notabug.org/ralessi/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 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 3 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. +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. +along with this program. If not, see +<http://www.gnu.org/licenses/>. This release of arabluatex consists of the following source files: @@ -59,17 +69,17 @@ source files: \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 +\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: + into a directory where LaTeX can find them. See the FAQ on + \verb|tex.ac.uk| at + \url{http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html} for more on this: \begin{itemize} \item \verb|arabluatex.sty| \item \verb|arabluatex.lua| @@ -80,4 +90,37 @@ into a directory searched by LaTeX. See the FAQ on CTAN at \end{itemize} \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} + +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://notabug.org/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 GNU/Linux +distributions package it in their repositories). + +Use this command to download the repository +\begin{verbatim} +git clone http://git.robertalessi.net/cgit.cgi/arabluatex +\end{verbatim} + + +A new directory named arabluatex will have been created, containing +ArabLuaTeX. Git hosting + +Please, do not use GitHub or GitLab: see +\href{https://libreboot.org/git/#githosting}{there}. + \end{document}
\ No newline at end of file |