aboutsummaryrefslogtreecommitdiff
path: root/README.tex
diff options
context:
space:
mode:
Diffstat (limited to 'README.tex')
-rw-r--r--README.tex81
1 files changed, 35 insertions, 46 deletions
diff --git a/README.tex b/README.tex
index 236dc06..dd413d3 100644
--- a/README.tex
+++ b/README.tex
@@ -1,6 +1,6 @@
1% The arabluatex package -- README file 1% The arabluatex package -- README file
2% Robert Alessi 2% Robert Alessi
3% March 18, 2017 3% January 29, 2023
4\documentclass{article} 4\documentclass{article}
5 5
6\usepackage{fontspec} 6\usepackage{fontspec}
@@ -16,48 +16,47 @@
16 16
17\section*{Overview} 17\section*{Overview}
18\label{sec:overview} 18\label{sec:overview}
19This package provides for \href{http://luatex.org}{Lua\LaTeX} an 19This package provides for \href{https://luatex.org}{Lua\LaTeX}
20\href{http://ctan.org/pkg/arabtex}{Arab\TeX}-like interface to 20an \href{https://ctan.org/pkg/arabtex}{Arab\TeX}-like interface to
21generate Arabic writing from an \textsc{ascii} transliteration. It is 21generate Arabic writing from an \textsc{ascii} transliteration. It is
22particularly well-suited for complex documents such as technical 22particularly well-suited for complex documents such as technical
23documents or critical editions where a lot of left-to-right commands 23documents or critical editions where a lot of left-to-right commands
24intertwine with Arabic writing. arabluatex is able to process any 24intertwine with Arabic writing. arabluatex is able to process any
25Arab\TeX\ input notation. Its output can be set in the same modes of 25Arab\TeX\ input notation. Its output can be set in the same modes of
26vocalization as Arab\TeX, or in different roman transliterations. It 26vocalization as Arab\TeX, or in different roman transliterations. It
27further allows many typographical refinements. It will eventually 27further allows many typographical refinements. It can also operate
28interact with some other packages yet to come to produce from 28with the \href{https://ctan.org/pkg/ekdosis}{ekdosis} package to
29\verb|.tex| source files, in addition to printed books, \texttt{TEI 29produce from \verb|.tex| source files, in addition to printed books,
30 xml} compliant critical editions and/or lexicons that can be 30\texttt{TEI xml} compliant critical editions and/or lexicons that can
31searched, analyzed and correlated in various ways. 31be searched, analyzed and correlated in various ways.
32 32
33\section*{License and disclamer} 33\section*{License and disclamer}
34ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX 34ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
35 35
36Copyright ⓒ 2016--2019 Robert Alessi 36Copyright ⓒ 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023
37Robert Alessi <\verb|alessi@robertalessi.net|>
38
39Permission to use, copy, modify, and distribute this software for any
40purpose with or without fee is hereby granted, provided that the above
41copyright notice and this permission notice appear in all copies.
42
43THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
44WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
45MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
46ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
47WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
48ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
49OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
37 50
38Please send error reports and suggestions for improvements to Robert 51Please send error reports and suggestions for improvements to Robert
39Alessi: 52Alessi:
40\begin{itemize} 53\begin{itemize}
41\item email: \href{mailto:alessi@robertalessi.net}{alessi@robertalessi.net} 54\item email: \href{mailto:alessi@robertalessi.net}{alessi@robertalessi.net}
42\item website: \url{http://www.robertalessi.net/arabluatex} 55\item website: \url{https://sr.ht/~ralessi/arabluatex}
43\item comments, feature requests, bug reports: 56\item comments, feature requests, bug reports:
44 \url{https://gitlab.com/ralessi/arabluatex/issues} 57 \url{https://todo.sr.ht/~ralessi/arabluatex}
45\end{itemize} 58\end{itemize}
46 59
47This program is free software: you can redistribute it and/or modify
48it under the terms of the GNU General Public License as published by
49the Free Software Foundation, either version 3 of the License, or
50(at your option) any later version.
51
52This program is distributed in the hope that it will be useful, but
53WITHOUT ANY WARRANTY; without even the implied warranty of
54MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
55General Public License for more details.
56
57You should have received a copy of the GNU General Public License
58along with this program. If not, see
59<http://www.gnu.org/licenses/>.
60
61This release of arabluatex consists of the following 60This release of arabluatex consists of the following
62source files: 61source files:
63\begin{itemize} 62\begin{itemize}
@@ -70,17 +69,6 @@ source files:
70\item \verb|arabluatex_trans.lua| 69\item \verb|arabluatex_trans.lua|
71\end{itemize} 70\end{itemize}
72 71
73\subsection*{License applicable to the documentation}
74\label{sec:documentation-license}
75Copyright ⓒ 2016--2019 Robert Alessi
76
77The documentation file \verb|arabluatex.pdf| that is generated from
78the \verb|arabluatex.dtx| source is licensed under the Creative
79Commons Attribution-ShareAlike 4.0 International License. To view a
80copy of this license, visit
81\url{http://creativecommons.org/licenses/by-sa/4.0/} or send a letter
82to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
83
84\section*{Installation} 72\section*{Installation}
85\label{sec:installation} 73\label{sec:installation}
86\begin{enumerate} 74\begin{enumerate}
@@ -111,36 +99,37 @@ to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
111\label{sec:browse-code} 99\label{sec:browse-code}
112 100
113You can browse ArabLua\TeX\ repository on the web: 101You can browse ArabLua\TeX\ repository on the web:
114\url{http://git.robertalessi.net/arabluatex} 102\url{http://git.robertalessi.net/arabluatex}\\
103or\\
104\url{https://sr.ht/~ralessi/arabluatex}
115 105
116From this page, you can download all the releases of ArabLua\TeX. For 106From this page, you can download all the releases of ArabLua\TeX. For
117instructions on how to install ArabLua\TeX, please see above. 107instructions on how to install ArabLua\TeX, please see above.
118 108
119\subsection*{Comments, Feature requests, Bug Reports} 109\subsection*{Comments, Feature requests, Bug Reports}
120\label{sec:comm-feat-requ} 110\label{sec:comm-feat-requ}
121\url{https://gitlab.com/ralessi/arabluatex/issues} 111\url{https://todo.sr.ht/~ralessi/arabluatex}
122 112
123\subsection*{Download the repository} 113\subsection*{Download the repository}
124\label{sec:download-repository} 114\label{sec:download-repository}
125ArabLua\TeX\ development is facilitated by git, a distributed version 115ArabLua\TeX\ development is facilitated by git, a distributed version
126control system. You will need to install git (most GNU/Linux 116control system. You will need to install git (most Unix/Linux
127distributions package it in their repositories). 117distributions package it in their repositories).
128 118
129Use this command to download the repository 119Use this command to download the repository
130\begin{verbatim} 120\begin{verbatim}
131git clone http://git.robertalessi.net/arabluatex 121git clone https://git.sr.ht/~ralessi/arabluatex
132\end{verbatim} 122\end{verbatim}
133 123
134
135A new directory named arabluatex will have been created, containing 124A new directory named arabluatex will have been created, containing
136ArabLuaTeX. 125ArabLuaTeX.
137 126
138\subsection*{Git hosting} 127\subsection*{Git hosting}
139\label{sec:git-hosting} 128\label{sec:git-hosting}
140Make an account on \url{https://gitlab.com} and navigate (while 129Make an account on \url{https://sr.ht} and navigate (while logged in)
141logged in) to \url{https://gitlab.com/ralessi/arabluatex}. Click 130to \url{https://git.sr.ht/~ralessi/arabluatex}. Click \emph{Clone repo
142\emph{Fork} and you will have in your account your own repository of 131 to your account} and you will have in your account your own
143\verb|arabluatex| where you will be able to make whatever changes you 132repository of \verb|arabluatex| where you will be able to make
144like to. 133whatever changes you like to.
145 134
146\end{document} \ No newline at end of file 135\end{document} \ No newline at end of file