aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2022-10-13 13:45:27 +0200
committerRobert Alessi <alessi@robertalessi.net>2022-10-13 13:45:27 +0200
commit2e19b51d0f23c572968b6c50abb1b1d210ffb131 (patch)
tree1feabe26f61f7aabc14cd18b54e8b09af674fb8d /README.md
parentad368579c2c97004420e44cc0ef9d3c729f85c8b (diff)
downloadarabluatex-2e19b51d0f23c572968b6c50abb1b1d210ffb131.tar.gz
use \reset@font in \LR
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 10 insertions, 19 deletions
diff --git a/README.md b/README.md
index e1ccf14..37594a6 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
1--- 1---
2author: 2author:
3- Robert Alessi 3- Robert Alessi
4title: 'The arabluatex package -- README file' 4title: The arabluatex package -- README file
5--- 5---
6 6
7Overview 7# Overview
8========
9 8
10This package provides for [LuaLaTeX](http://luatex.org) an 9This package provides for [LuaLaTeX](http://luatex.org) an
11[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic 10[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic
@@ -20,8 +19,7 @@ packages yet to come to produce from `.tex` source files, in addition to
20printed books, `TEI xml` compliant critical editions and/or lexicons 19printed books, `TEI xml` compliant critical editions and/or lexicons
21that can be searched, analyzed and correlated in various ways. 20that can be searched, analyzed and correlated in various ways.
22 21
23License and disclamer 22# License and disclamer
24=====================
25 23
26ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX 24ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
27 25
@@ -66,8 +64,7 @@ This release of arabluatex consists of the following source files:
66 64
67- `arabluatex_trans.lua` 65- `arabluatex_trans.lua`
68 66
69License applicable to the documentation 67## License applicable to the documentation
70---------------------------------------
71 68
72Copyright ⓒ 2016--2022 Robert Alessi 69Copyright ⓒ 2016--2022 Robert Alessi
73 70
@@ -78,8 +75,7 @@ Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
78copy of the license is included in the section entitled "GNU Free 75copy of the license is included in the section entitled "GNU Free
79Documentation License" of the documentation. 76Documentation License" of the documentation.
80 77
81Installation 78# Installation
82============
83 79
841. Run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty` 801. Run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty`
85 file; 81 file;
@@ -106,11 +102,9 @@ Installation
106 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory. 102 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory.
107 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX. 103 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX.
108 104
109Development, Git Repository 105# Development, Git Repository
110===========================
111 106
112Browse the code 107## Browse the code
113---------------
114 108
115You can browse ArabLuaTeX repository on the web: 109You can browse ArabLuaTeX repository on the web:
116<http://git.robertalessi.net/arabluatex> 110<http://git.robertalessi.net/arabluatex>
@@ -118,13 +112,11 @@ You can browse ArabLuaTeX repository on the web:
118From this page, you can download all the releases of ArabLuaTeX. For 112From this page, you can download all the releases of ArabLuaTeX. For
119instructions on how to install ArabLuaTeX, please see above. 113instructions on how to install ArabLuaTeX, please see above.
120 114
121Comments, Feature requests, Bug Reports 115## Comments, Feature requests, Bug Reports
122---------------------------------------
123 116
124<https://gitlab.com/ralessi/arabluatex/issues> 117<https://gitlab.com/ralessi/arabluatex/issues>
125 118
126Download the repository 119## Download the repository
127-----------------------
128 120
129ArabLuaTeX development is facilitated by git, a distributed version 121ArabLuaTeX development is facilitated by git, a distributed version
130control system. You will need to install git (most GNU/Linux 122control system. You will need to install git (most GNU/Linux
@@ -137,8 +129,7 @@ Use this command to download the repository
137A new directory named arabluatex will have been created, containing 129A new directory named arabluatex will have been created, containing
138ArabLuaTeX. 130ArabLuaTeX.
139 131
140Git hosting 132## Git hosting
141-----------
142 133
143Make an account on <https://gitlab.com> and navigate (while logged in) 134Make an account on <https://gitlab.com> and navigate (while logged in)
144to <https://gitlab.com/ralessi/arabluatex>. Click *Fork* and you will 135to <https://gitlab.com/ralessi/arabluatex>. Click *Fork* and you will