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