aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2023-01-24 16:14:18 +0100
committerRobert Alessi <alessi@robertalessi.net>2023-01-24 16:14:18 +0100
commit3a4d0bb9c40a92f8cbde4ce2af66038c8c6e0543 (patch)
treee4c9c07a76f91bb25a141180d79871859aa48e5e /README.md
parent7e40727a39b76d13a2f0e795b1d1f4be1855f670 (diff)
downloadarabluatex-3a4d0bb9c40a92f8cbde4ce2af66038c8c6e0543.tar.gz
v1.21 to come will be licensed under OpenBSD terms
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 27 insertions, 35 deletions
diff --git a/README.md b/README.md
index c186d18..7e73a72 100644
--- a/README.md
+++ b/README.md
@@ -17,30 +17,30 @@ that can be searched, analyzed and correlated in various ways.
17 17
18ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX 18ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
19 19
20Copyright ⓒ 2016--2022 Robert Alessi 20Copyright ⓒ 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Robert Alessi
21\<`alessi@robertalessi.net`\>
22
23Permission to use, copy, modify, and distribute this software for any
24purpose with or without fee is hereby granted, provided that the above
25copyright notice and this permission notice appear in all copies.
26
27THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL
28WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
29OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
30FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
31DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
32IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
33OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 34
22Please send error reports and suggestions for improvements to Robert 35Please send error reports and suggestions for improvements to Robert
23Alessi: 36Alessi:
24 37
25- email: <alessi@robertalessi.net> 38- email: <alessi@robertalessi.net>
26 39
27- website: <http://www.robertalessi.net/arabluatex> 40- website: <https://sr.ht/~ralessi/arabluatex>
28 41
29- comments, feature requests, bug reports: 42- comments, feature requests, bug reports:
30 <https://gitlab.com/ralessi/arabluatex/issues> 43 <https://todo.sr.ht/~ralessi/arabluatex>
31
32This program is free software: you can redistribute it and/or modify it
33under the terms of the GNU General Public License as published by the
34Free Software Foundation, either version 3 of the License, or (at your
35option) any later version.
36
37This program is distributed in the hope that it will be useful, but
38WITHOUT ANY WARRANTY; without even the implied warranty of
39MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
40Public License for more details.
41
42You should have received a copy of the GNU General Public License along
43with this program. If not, see \<http://www.gnu.org/licenses/\>.
44 44
45This release of arabluatex consists of the following source files: 45This release of arabluatex consists of the following source files:
46 46
@@ -58,17 +58,6 @@ This release of arabluatex consists of the following source files:
58 58
59- `arabluatex_trans.lua` 59- `arabluatex_trans.lua`
60 60
61## License applicable to the documentation
62
63Copyright ⓒ 2016--2022 Robert Alessi
64
65Permission is granted to copy, distribute and/or modify this document
66under the terms of the GNU Free Documentation License, Version 1.3 or
67any later version published by the Free Software Foundation; with no
68Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
69copy of the license is included in the section entitled "GNU Free
70Documentation License" of the documentation.
71
72# Installation 61# Installation
73 62
741. Run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty` 631. Run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty`
@@ -101,31 +90,34 @@ Documentation License" of the documentation.
101## Browse the code 90## Browse the code
102 91
103You can browse ArabLuaTeX repository on the web: 92You can browse ArabLuaTeX repository on the web:
104<http://git.robertalessi.net/arabluatex> 93<http://git.robertalessi.net/arabluatex>\
94or\
95<https://sr.ht/~ralessi/arabluatex>
105 96
106From this page, you can download all the releases of ArabLuaTeX. For 97From this page, you can download all the releases of ArabLuaTeX. For
107instructions on how to install ArabLuaTeX, please see above. 98instructions on how to install ArabLuaTeX, please see above.
108 99
109## Comments, Feature requests, Bug Reports 100## Comments, Feature requests, Bug Reports
110 101
111<https://gitlab.com/ralessi/arabluatex/issues> 102<https://todo.sr.ht/~ralessi/arabluatex>
112 103
113## Download the repository 104## Download the repository
114 105
115ArabLuaTeX development is facilitated by git, a distributed version 106ArabLuaTeX development is facilitated by git, a distributed version
116control system. You will need to install git (most GNU/Linux 107control system. You will need to install git (most Unix/Linux
117distributions package it in their repositories). 108distributions package it in their repositories).
118 109
119Use this command to download the repository 110Use this command to download the repository
120 111
121 git clone http://git.robertalessi.net/arabluatex 112 git clone https://git.sr.ht/~ralessi/arabluatex
122 113
123A new directory named arabluatex will have been created, containing 114A new directory named arabluatex will have been created, containing
124ArabLuaTeX. 115ArabLuaTeX.
125 116
126## Git hosting 117## Git hosting
127 118
128Make an account on <https://gitlab.com> and navigate (while logged in) 119Make an account on <https://sh.ht> and navigate (while logged in) to
129to <https://gitlab.com/ralessi/arabluatex>. Click *Fork* and you will 120<https://git.sr.ht/~ralessi/arabluatex>. Click *Clone repo to your
130have in your account your own repository of `arabluatex` where you will 121account* and you will have in your account your own repository of
131be able to make whatever changes you like to. 122`arabluatex` where you will be able to make whatever changes you like
123to.