From 1fbd4becbd764809ea7f31ca85f26ec3c20af9e9 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Wed, 8 Jul 2020 18:22:28 +0200 Subject: final adjustments. this is v0.99a --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f5abd41..4baa1e9 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,18 @@ 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 +Notice to the Gentle Reader +=========================== +The current state of this documentation covers the basics of +`ekdosis`, namely what should be enough to start a new document and +see how it works. v1.0 with a full documentation should be out by the +end of July. Until then, there is a web page that can be accessed, +, with a mailing list that one can +subscribe to and a section entitled “Literature” where one will find +some slides and a paper submitted to a journal. + +License and Disclamer ===================== - ekdosis – Typesetting TEI xml Compliant Critical Editions Copyright ⓒ 2020 Robert Alessi @@ -60,9 +68,8 @@ This release of icite consists of the following source files: - `Makefile` -License applicable to the documentation +License Applicable to the Documentation --------------------------------------- - Copyright ⓒ 2020 Robert Alessi The documentation file `ekdosis.pdf` that is generated from the @@ -78,7 +85,6 @@ Permission is granted to copy, distribute and/or modify this document Installation ============ - 1. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and `ekdosis.lua` files. @@ -90,23 +96,21 @@ Installation Development, Git Repository =========================== -Browse the code +Browse the Code --------------- - You can browse icite repository on the web: 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 +Comments, Feature Requests, Bug Reports --------------------------------------- - -Download the repository ------------------------ +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). @@ -118,11 +122,9 @@ Use this command to download the repository A new directory named icite will have been created, containing `ekdosis`. -Git hosting +Git Hosting ----------- - Make an account on and navigate (while logged in) to . 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. - -- cgit v1.2.3