diff options
-rw-r--r-- | README.md | 83 | ||||
-rw-r--r-- | makefile | 2 |
2 files changed, 84 insertions, 1 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad8cec4 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,83 @@ | |||
1 | Overview {#sec:overview .unnumbered} | ||
2 | ======== | ||
3 | |||
4 | This package provides for LuaLaTeX an Arab<span>TeX</span>-like | ||
5 | interface to generate Arabic writing from an <span | ||
6 | style="font-variant:small-caps;">ascii</span> transliteration. It is | ||
7 | particularly well-suited for complex documents such as technical | ||
8 | documents or critical editions where a lot of left-to-right commands | ||
9 | intertwine with Arabic writing. arabluatex is able to process any | ||
10 | ArabTeX input notation. Its output can be set in the same modes of | ||
11 | vocalization as ArabTeX, or in different roman transliterations. It | ||
12 | further allows many typographical refinements. It will eventually | ||
13 | interact with some other packages yet to come to produce from `.tex` | ||
14 | source files, in addition to printed books, `TEI xml` compliant critical | ||
15 | editions and/or lexicons that can be searched, analyzed and correlated | ||
16 | in various ways. | ||
17 | |||
18 | License and disclamer {#license-and-disclamer .unnumbered} | ||
19 | ===================== | ||
20 | |||
21 | Copyright ⓒ 2016 Robert Alessi | ||
22 | |||
23 | Please send error reports and suggestions for improvements to Robert | ||
24 | Alessi: | ||
25 | |||
26 | - email: [alessi@robertalessi.net](alessi@robertalessi.net) | ||
27 | |||
28 | - website: <http://www.robertalessi.net/arabluatex> | ||
29 | |||
30 | This program is free software; you can redistribute it and/or modify it | ||
31 | under the terms of the GNU General Public License as published by the | ||
32 | Free Software Foundation; either version 2 of the License, or (at your | ||
33 | option) any later version. | ||
34 | |||
35 | This program is distributed in the hope that it will be useful, but | ||
36 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
37 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | ||
38 | Public License for more details. | ||
39 | |||
40 | You should have received a copy of the GNU General Public License along | ||
41 | with this program; if not, write to the Free Software Foundation, Inc., | ||
42 | 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | ||
43 | |||
44 | This release of arabluatex consists of the following source files: | ||
45 | |||
46 | - `arabluatex.ins` | ||
47 | |||
48 | - `arabluatex.dtx` | ||
49 | |||
50 | - `arabluatex.lua` | ||
51 | |||
52 | - `arabluatex_voc.lua` | ||
53 | |||
54 | - `arabluatex_fullvoc.lua` | ||
55 | |||
56 | - `arabluatex_novoc.lua` | ||
57 | |||
58 | - `arabluatex_trans.lua` | ||
59 | |||
60 | - `arabluatex.bib` | ||
61 | |||
62 | Installation {#sec:installation .unnumbered} | ||
63 | ============ | ||
64 | |||
65 | 1. run `lualatex arabluatex.ins` to produce the `arabluatex.sty` file; | ||
66 | |||
67 | 2. To finish the installation you have to move the following files into | ||
68 | a directory searched by LaTeX. See the FAQ on CTAN at | ||
69 | /help/uk-tex-faq for more on this: | ||
70 | |||
71 | - `arabluatex.sty` | ||
72 | |||
73 | - `arabluatex.lua` | ||
74 | |||
75 | - `arabluatex_voc.lua` | ||
76 | |||
77 | - `arabluatex_fullvoc.lua` | ||
78 | |||
79 | - `arabluatex_novoc.lua` | ||
80 | |||
81 | - `arabluatex_trans.lua` | ||
82 | |||
83 | |||
@@ -21,7 +21,6 @@ local: clean sty | |||
21 | cp $(pkg)*.{sty,lua} ~/texmf/tex/lualatex/arabluatex | 21 | cp $(pkg)*.{sty,lua} ~/texmf/tex/lualatex/arabluatex |
22 | 22 | ||
23 | package: clean all | 23 | package: clean all |
24 | pandoc README.tex -o README.md | ||
25 | mkdir arabluatex | 24 | mkdir arabluatex |
26 | cp *.lua *.ins *.dtx *.bib *.md *.pdf arabluatex/ | 25 | cp *.lua *.ins *.dtx *.bib *.md *.pdf arabluatex/ |
27 | mkdir -p tex/lualatex/arabluatex/ | 26 | mkdir -p tex/lualatex/arabluatex/ |
@@ -43,4 +42,5 @@ clean: | |||
43 | rm *.* | 42 | rm *.* |
44 | cp saved/* . | 43 | cp saved/* . |
45 | rm -rf saved/ | 44 | rm -rf saved/ |
45 | pandoc README.tex -o README.md | ||
46 | pandoc README.tex -o about.html | 46 | pandoc README.tex -o about.html |