aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md123
1 files changed, 50 insertions, 73 deletions
diff --git a/README.md b/README.md
index e110efd..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
7\maketitle 7documents or critical editions where a lot of left-to-right commands
8Overview 8intertwine with Arabic writing. arabluatex is able to process any
9======== 9ArabTeX input notation. Its output can be set in the same modes of
10 10vocalization as ArabTeX, or in different roman transliterations. It
11This package provides for [LuaLaTeX](http://luatex.org) an 11further allows many typographical refinements. It can also operate with
12[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic 12the [ekdosis](https://ctan.org/pkg/ekdosis) package to produce from
13writing from an [ascii]{.smallcaps} transliteration. It is particularly 13`.tex` source files, in addition to printed books, `TEI xml` compliant
14well-suited for complex documents such as technical documents or 14critical editions and/or lexicons that can be searched, analyzed and
15critical editions where a lot of left-to-right commands intertwine with 15correlated in various ways.
16Arabic writing. arabluatex is able to process any ArabTeX input 16
17notation. Its output can be set in the same modes of vocalization as 17# License and disclamer
18ArabTeX, or in different roman transliterations. It further allows many
19typographical refinements. It will eventually interact with some other
20packages yet to come to produce from `.tex` source files, in addition to
21printed books, `TEI xml` compliant critical editions and/or lexicons
22that can be searched, analyzed and correlated in various ways.
23
24License and disclamer
25=====================
26 18
27ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX 19ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
28 20
29Copyright ⓒ 2016--2020 Robert Alessi 21Copyright ⓒ 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Robert Alessi
22\<`alessi@robertalessi.net`\>
23
24Permission to use, copy, modify, and distribute this software for any
25purpose with or without fee is hereby granted, provided that the above
26copyright notice and this permission notice appear in all copies.
27
28THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL
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 \<http://www.gnu.org/licenses/\>.
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,20 +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--2020 Robert Alessi
74
75Permission is granted to copy, distribute and/or modify this document
76under the terms of the GNU Free Documentation License, Version 1.3 or
77any later version published by the Free Software Foundation; with no
78Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
79copy of the license is included in the section entitled "GNU Free
80Documentation License" of the documentation.
81
82Installation
83============
84 63
851. Run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty` 641. Run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty`
86 file; 65 file;
@@ -107,41 +86,39 @@ Installation
107 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory. 86 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory.
108 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX. 87 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX.
109 88
110Development, Git Repository 89# Development, Git Repository
111===========================
112 90
113Browse the code 91## Browse the code
114---------------
115 92
116You can browse ArabLuaTeX repository on the web: 93You can browse ArabLuaTeX repository on the web:
117<http://git.robertalessi.net/arabluatex> 94<http://git.robertalessi.net/arabluatex>\
95or\
96<https://sr.ht/~ralessi/arabluatex>
118 97
119From this page, you can download all the releases of ArabLuaTeX. For 98From this page, you can download all the releases of ArabLuaTeX. For
120instructions on how to install ArabLuaTeX, please see above. 99instructions on how to install ArabLuaTeX, please see above.
121 100
122Comments, Feature requests, Bug Reports 101## Comments, Feature requests, Bug Reports
123---------------------------------------
124 102
125<https://gitlab.com/ralessi/arabluatex/issues> 103<https://todo.sr.ht/~ralessi/arabluatex>
126 104
127Download the repository 105## Download the repository
128-----------------------
129 106
130ArabLuaTeX development is facilitated by git, a distributed version 107ArabLuaTeX development is facilitated by git, a distributed version
131control system. You will need to install git (most GNU/Linux 108control system. You will need to install git (most Unix/Linux
132distributions package it in their repositories). 109distributions package it in their repositories).
133 110
134Use this command to download the repository 111Use this command to download the repository
135 112
136 git clone http://git.robertalessi.net/arabluatex 113 git clone https://git.sr.ht/~ralessi/arabluatex
137 114
138A new directory named arabluatex will have been created, containing 115A new directory named arabluatex will have been created, containing
139ArabLuaTeX. 116ArabLuaTeX.
140 117
141Git hosting 118## Git hosting
142-----------
143 119
144Make an account on <https://gitlab.com> and navigate (while logged in) 120Make an account on <https://sr.ht> and navigate (while logged in) to
145to <https://gitlab.com/ralessi/arabluatex>. Click *Fork* and you will 121<https://git.sr.ht/~ralessi/arabluatex>. Click *Clone repo to your
146have in your account your own repository of `arabluatex` where you will 122account* and you will have in your account your own repository of
147be able to make whatever changes you like to. 123`arabluatex` where you will be able to make whatever changes you like
124to.