aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 17 insertions, 15 deletions
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
19published under the terms of the GNU General Public License (GPL) 19published under the terms of the GNU General Public License (GPL)
20version 3. 20version 3.
21 21
22 22Notice to the Gentle Reader
23License and disclamer 23===========================
24The current state of this documentation covers the basics of
25`ekdosis`, namely what should be enough to start a new document and
26see how it works. v1.0 with a full documentation should be out by the
27end of July. Until then, there is a web page that can be accessed,
28<http://www.robertalessi.net/ekdosis>, with a mailing list that one can
29subscribe to and a section entitled “Literature” where one will find
30some slides and a paper submitted to a journal.
31
32License and Disclamer
24===================== 33=====================
25
26ekdosis – Typesetting TEI xml Compliant Critical Editions 34ekdosis – Typesetting TEI xml Compliant Critical Editions
27 35
28Copyright ⓒ 2020 Robert Alessi 36Copyright ⓒ 2020 Robert Alessi
@@ -60,9 +68,8 @@ This release of icite consists of the following source files:
60 68
61- `Makefile` 69- `Makefile`
62 70
63License applicable to the documentation 71License Applicable to the Documentation
64--------------------------------------- 72---------------------------------------
65
66Copyright ⓒ 2020 Robert Alessi 73Copyright ⓒ 2020 Robert Alessi
67 74
68The documentation file `ekdosis.pdf` that is generated from the 75The documentation file `ekdosis.pdf` that is generated from the
@@ -78,7 +85,6 @@ Permission is granted to copy, distribute and/or modify this document
78 85
79Installation 86Installation
80============ 87============
81
821. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and 881. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and
83 `ekdosis.lua` files. 89 `ekdosis.lua` files.
84 90
@@ -90,23 +96,21 @@ Installation
90Development, Git Repository 96Development, Git Repository
91=========================== 97===========================
92 98
93Browse the code 99Browse the Code
94--------------- 100---------------
95
96You can browse icite repository on the web: 101You can browse icite repository on the web:
97<http://git.robertalessi.net/ekdosis> 102<http://git.robertalessi.net/ekdosis>
98 103
99From this page, you can download all the releases of `ekdosis`. For 104From this page, you can download all the releases of `ekdosis`. For
100instructions on how to install `ekdosis`, please see above. 105instructions on how to install `ekdosis`, please see above.
101 106
102Comments, Feature requests, Bug Reports 107Comments, Feature Requests, Bug Reports
103--------------------------------------- 108---------------------------------------
104
105<https://gitlab.com/ralessi/ekdosis/issues> 109<https://gitlab.com/ralessi/ekdosis/issues>
106 110
107Download the repository
108-----------------------
109 111
112Download the Repository
113-----------------------
110`ekdosis` development is facilitated by git, a distributed version 114`ekdosis` development is facilitated by git, a distributed version
111control system. You will need to install git (most GNU/Linux 115control system. You will need to install git (most GNU/Linux
112distributions package it in their repositories). 116distributions package it in their repositories).
@@ -118,11 +122,9 @@ Use this command to download the repository
118A new directory named icite will have been created, containing 122A new directory named icite will have been created, containing
119`ekdosis`. 123`ekdosis`.
120 124
121Git hosting 125Git Hosting
122----------- 126-----------
123
124Make an account on <https://gitlab.com> and navigate (while logged in) 127Make an account on <https://gitlab.com> and navigate (while logged in)
125to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will 128to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will
126have in your account your own repository of `ekdosis` where you will 129have in your account your own repository of `ekdosis` where you will
127be able to make whatever changes you like to. 130be able to make whatever changes you like to.
128