added README.md and about.html

5 files changed, 188 insertions, 20 deletions

diff --git a/Makefile b/Makefile
index 43430a6..338813b 100644
--- a/Makefile
+++ b/Makefile
@@ -7,11 +7,11 @@ LOCAL = $(shell kpsewhich --var-value TEXMFLOCAL)
 UTREE = $(shell kpsewhich --var-value TEXMFHOME)
 HOMEDIR := $$HOME
 
-exts := ins dtx el
+exts := md html ins dtx el
 findopts := $(foreach ext,$(exts),-or -iname "*.$(ext)")
 
 all:    sty $(NAME).pdf
-        test -e README.txt && mv README.txt README || exit 0
+#       test -e README.txt && mv README.txt README || exit 0
 
 sty: clean
         $(CMP) $(NAME).ins
@@ -38,7 +38,7 @@ clean:
         rm -rf *
         cp -p -r .backup/* .
         rm -rf .backup
-#       pandoc -s README.md -o about.html
+        pandoc -s README.md -o about.html
 
 auctex:
         if [ ! -d "$(HOMEDIR)/.emacs.d/auctex/auto" ]; then \
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab453a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,126 @@
+---
+author:
+- Robert Alessi
+title: 'The ekdosis package – README file'
+---
+
+Overview
+========
+`ekdosis` is a LuaLaTeX package designed for multilingual critical
+editions. It can be used to typeset texts and different layers of
+critical notes in any direction accepted by LuaTeX. Texts can be
+arranged in running paragraphs or on facing pages, in any number of
+columns which in turn can be synchronized or not. In addition to
+printed texts, `ekdosis` can convert `.tex` source files so as to
+produce `TEI xml` compliant critical editions. Database-driven
+encoding under LaTeX then allows extraction of texts entered segment
+by segment according to various criteria: main edited text, variant
+readings, translations or annotated borrowings between texts. It is
+published under the terms of the GNU General Public License (GPL)
+version 3.
+
+
+License and disclamer
+=====================
+
+ekdosis – Typesetting TEI xml compliant critical editions
+
+Copyright ⓒ 2020 Robert Alessi
+
+Please send error reports and suggestions for improvements to Robert
+Alessi:
+
+-   email: <alessi@robertalessi.net>
+
+-   website: <http://www.robertalessi.net/ekdosis>
+
+-   comments, feature requests, bug reports:
+    <https://gitlab.com/ralessi/ekdosis/issues>
+
+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 3 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, see <http://www.gnu.org/licenses/>.
+
+This release of icite consists of the following source files:
+
+-   `ekdosis.dtx`
+
+-   `ekdosis.ins`
+
+-   `Makefile`
+
+License applicable to the documentation
+---------------------------------------
+
+Copyright ⓒ 2020 Robert Alessi
+
+The documentation file `ekdosis.pdf` that is generated from the
+`ekdosis.dtx` source file is licensed under the GNU Free Documentation
+License, as follows:---
+
+Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.3
+  or any later version published by the Free Software Foundation; with
+  no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+  Texts.  A copy of the license is included in the section entitled
+  “GNU Free Documentation License”.
+
+Installation
+============
+
+1.  Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and
+    `ekdosis.lua` files.
+
+2.  To finish the installation you have to move the `ekdosis.sty` and
+    `ekdosis.lua` files into a directory where LaTeX can find it. See
+    the FAQ on `texfaq.org` at <https://texfaq.org/FAQ-inst-wlcf> for
+    more on this.
+
+Development, Git Repository
+===========================
+
+Browse the code
+---------------
+
+You can browse icite repository on the web:
+<http://git.robertalessi.net/ekdosis>
+
+From this page, you can download all the releases of `ekdosis`. For
+instructions on how to install `ekdosis`, please see above.
+
+Comments, Feature requests, Bug Reports
+---------------------------------------
+
+<https://gitlab.com/ralessi/ekdosis/issues>
+
+Download the repository
+-----------------------
+
+`ekdosis` development is facilitated by git, a distributed version
+control system. You will need to install git (most GNU/Linux
+distributions package it in their repositories).
+
+Use this command to download the repository
+
+    git clone http://git.robertalessi.net/ekdosis
+
+A new directory named icite will have been created, containing
+`ekdosis`.
+
+Git hosting
+-----------
+
+Make an account on <https://gitlab.com> and navigate (while logged in)
+to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will
+have in your account your own repository of `ekdosis` where you will
+be able to make whatever changes you like to.
+
diff --git a/about.html b/about.html
new file mode 100644
index 0000000..9fc50c0
--- /dev/null
+++ b/about.html
@@ -0,0 +1,59 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Style-Type" content="text/css" />
+  <meta name="generator" content="pandoc" />
+  <meta name="author" content="Robert Alessi" />
+  <title>The ekdosis package – README file</title>
+  <style type="text/css">code{white-space: pre;}</style>
+</head>
+<body>
+<div id="header">
+<h1 class="title">The ekdosis package – README file</h1>
+<h2 class="author">Robert Alessi</h2>
+</div>
+<h1 id="overview">Overview</h1>
+<p><code>ekdosis</code> is a LuaLaTeX package designed for multilingual critical editions. It can be used to typeset texts and different layers of critical notes in any direction accepted by LuaTeX. Texts can be arranged in running paragraphs or on facing pages, in any number of columns which in turn can be synchronized or not. In addition to printed texts, <code>ekdosis</code> can convert <code>.tex</code> source files so as to produce <code>TEI xml</code> compliant critical editions. Database-driven encoding under LaTeX then allows extraction of texts entered segment by segment according to various criteria: main edited text, variant readings, translations or annotated borrowings between texts. It is published under the terms of the GNU General Public License (GPL) version 3.</p>
+<h1 id="license-and-disclamer">License and disclamer</h1>
+<p>ekdosis – Typesetting TEI xml compliant critical editions</p>
+<p>Copyright ⓒ 2020 Robert Alessi</p>
+<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
+<ul>
+<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
+<li><p>website: <a href="http://www.robertalessi.net/ekdosis" class="uri">http://www.robertalessi.net/ekdosis</a></p></li>
+<li><p>comments, feature requests, bug reports: <a href="https://gitlab.com/ralessi/ekdosis/issues" class="uri">https://gitlab.com/ralessi/ekdosis/issues</a></p></li>
+</ul>
+<p>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 3 of the License, or (at your option) any later version.</p>
+<p>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.</p>
+<p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/" class="uri">http://www.gnu.org/licenses/</a>.</p>
+<p>This release of icite consists of the following source files:</p>
+<ul>
+<li><p><code>ekdosis.dtx</code></p></li>
+<li><p><code>ekdosis.ins</code></p></li>
+<li><p><code>Makefile</code></p></li>
+</ul>
+<h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2>
+<p>Copyright ⓒ 2020 Robert Alessi</p>
+<p>The documentation file <code>ekdosis.pdf</code> that is generated from the <code>ekdosis.dtx</code> source file is licensed under the GNU Free Documentation License, as follows:---</p>
+<p>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.</p>
+<h1 id="installation">Installation</h1>
+<ol style="list-style-type: decimal">
+<li><p>Run <code>'latex ekdosis.ins'</code> to produce the <code>ekdosis.sty</code> and <code>ekdosis.lua</code> files.</p></li>
+<li><p>To finish the installation you have to move the <code>ekdosis.sty</code> and <code>ekdosis.lua</code> files into a directory where LaTeX can find it. See the FAQ on <code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf" class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this.</p></li>
+</ol>
+<h1 id="development-git-repository">Development, Git Repository</h1>
+<h2 id="browse-the-code">Browse the code</h2>
+<p>You can browse icite repository on the web: <a href="http://git.robertalessi.net/ekdosis" class="uri">http://git.robertalessi.net/ekdosis</a></p>
+<p>From this page, you can download all the releases of <code>ekdosis</code>. For instructions on how to install <code>ekdosis</code>, please see above.</p>
+<h2 id="comments-feature-requests-bug-reports">Comments, Feature requests, Bug Reports</h2>
+<p><a href="https://gitlab.com/ralessi/ekdosis/issues" class="uri">https://gitlab.com/ralessi/ekdosis/issues</a></p>
+<h2 id="download-the-repository">Download the repository</h2>
+<p><code>ekdosis</code> development is facilitated by git, a distributed version control system. You will need to install git (most GNU/Linux distributions package it in their repositories).</p>
+<p>Use this command to download the repository</p>
+<pre><code>git clone http://git.robertalessi.net/ekdosis</code></pre>
+<p>A new directory named icite will have been created, containing <code>ekdosis</code>.</p>
+<h2 id="git-hosting">Git hosting</h2>
+<p>Make an account on <a href="https://gitlab.com" class="uri">https://gitlab.com</a> and navigate (while logged in) to <a href="https://gitlab.com/ralessi/ekdosis" class="uri">https://gitlab.com/ralessi/ekdosis</a>. Click <em>Fork</em> and you will have in your account your own repository of <code>ekdosis</code> where you will be able to make whatever changes you like to.</p>
+</body>
+</html>
diff --git a/ekdosis.dtx b/ekdosis.dtx
index bc2695b..908162d 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -23,19 +23,6 @@
 %<*internal>
 \iffalse
 %</internal>
-%<*readme>
-|
--------:| -----------------------------------------------------------------
-ekdosis:| Typesetting TEI xml compliant critical editions
- Author:| Robert Alessi
- E-mail:| alessi@robertalessi.net
-License:| Released under the GNU General Public License v3 or later
-    See:| http://www.gnu.org/licenses/
-
-
-Short description:
-Some text about the package: probably the same as the abstract.
-%</readme>
 %<*luapre>
 --[[
 This file is part of the `ekdosis' package
diff --git a/ekdosis.ins b/ekdosis.ins
index 4085554..f1558f2 100644
--- a/ekdosis.ins
+++ b/ekdosis.ins
@@ -58,8 +58,4 @@ Running "make install" installs the files in the local TeX tree.
 %     \from{\jobname.dtx}{examples}
 %   }
 % }
-\usedir{doc/lualatex/ekdosis}
-\generate{
-  \file{README.txt}{\from{\jobname.dtx}{readme}}
-}
 \endbatchfile