1 files changed, 83 insertions, 0 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 @@
+Overview {#sec:overview .unnumbered}
+========
+
+This package provides for LuaLaTeX an Arab<span>TeX</span>-like
+interface to generate Arabic writing from an <span
+style="font-variant:small-caps;">ascii</span> 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 {#license-and-disclamer .unnumbered}
+=====================
+
+Copyright ⓒ 2016 Robert Alessi
+
+Please send error reports and suggestions for improvements to Robert
+Alessi:
+
+-   email: [alessi@robertalessi.net](alessi@robertalessi.net)
+
+-   website: <http://www.robertalessi.net/arabluatex>
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+This release of arabluatex consists of the following source files:
+
+-   `arabluatex.ins`
+
+-   `arabluatex.dtx`
+
+-   `arabluatex.lua`
+
+-   `arabluatex_voc.lua`
+
+-   `arabluatex_fullvoc.lua`
+
+-   `arabluatex_novoc.lua`
+
+-   `arabluatex_trans.lua`
+
+-   `arabluatex.bib`
+
+Installation {#sec:installation .unnumbered}
+============
+
+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 searched by LaTeX. See the FAQ on CTAN at
+    /help/uk-tex-faq for more on this:
+
+    -   `arabluatex.sty`
+
+    -   `arabluatex.lua`
+
+    -   `arabluatex_voc.lua`
+
+    -   `arabluatex_fullvoc.lua`
+
+    -   `arabluatex_novoc.lua`
+
+    -   `arabluatex_trans.lua`
+
+