From a0cabb2f3e821251d81ae678df0e906286b6bc5a Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Tue, 5 Apr 2016 10:29:55 +0200 Subject: .md and .html files are now standalone --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2e1df44..d686738 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,31 @@ +--- +author: +- Robert Alessi +title: 'The arabluatex package – README file' +--- + Overview ======== -This package provides for LuaLaTeX an ArabTeX-like -interface to generate Arabic writing from an ascii transliteration. It is -particularly well-suited for complex documents such as technical -documents or critical editions where a lot of left-to-right commands -intertwine with Arabic writing. arabluatex is able to process any -ArabTeX input notation. Its output can be set in the same modes of -vocalization as ArabTeX, or in different roman transliterations. It -further allows many typographical refinements. It will eventually -interact with some other packages yet to come to produce from `.tex` -source files, in addition to printed books, `TEI xml` compliant critical -editions and/or lexicons that can be searched, analyzed and correlated -in various ways. +This package provides for [LuaLaTeX](http://luatex.org) an +[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic +writing from an ascii +transliteration. It is particularly well-suited for complex documents +such as technical documents or critical editions where a lot of +left-to-right commands intertwine with Arabic writing. arabluatex is +able to process any ArabTeX input notation. Its output can be set in the +same modes of vocalization as ArabTeX, or in different roman +transliterations. It further allows many typographical refinements. It +will eventually interact with some other packages yet to come to produce +from `.tex` source files, in addition to printed books, `TEI xml` +compliant critical editions and/or lexicons that can be searched, +analyzed and correlated in various ways. License and disclamer ===================== -Copyright ⓒ 2016 Robert Alessi - -Please send error reports and suggestions for improvements to Robert -Alessi: +Copyright ⓒ 2016 Robert Alessi Please send error reports and suggestions +for improvements to Robert Alessi: - email: [alessi@robertalessi.net](alessi@robertalessi.net) @@ -62,7 +66,8 @@ This release of arabluatex consists of the following source files: Installation ============ -1. run `lualatex arabluatex.ins` to produce the `arabluatex.sty` file; +1. run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty` + file; 2. To finish the installation you have to move the following files into a directory where LaTeX can find them. See the FAQ on `tex.ac.uk` at -- cgit v1.2.3