diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ab453a1 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,126 @@ | |||
1 | --- | ||
2 | author: | ||
3 | - Robert Alessi | ||
4 | title: 'The ekdosis package – README file' | ||
5 | --- | ||
6 | |||
7 | Overview | ||
8 | ======== | ||
9 | `ekdosis` is a LuaLaTeX package designed for multilingual critical | ||
10 | editions. It can be used to typeset texts and different layers of | ||
11 | critical notes in any direction accepted by LuaTeX. Texts can be | ||
12 | arranged in running paragraphs or on facing pages, in any number of | ||
13 | columns which in turn can be synchronized or not. In addition to | ||
14 | printed texts, `ekdosis` can convert `.tex` source files so as to | ||
15 | produce `TEI xml` compliant critical editions. Database-driven | ||
16 | encoding under LaTeX then allows extraction of texts entered segment | ||
17 | by segment according to various criteria: main edited text, variant | ||
18 | readings, translations or annotated borrowings between texts. It is | ||
19 | published under the terms of the GNU General Public License (GPL) | ||
20 | version 3. | ||
21 | |||
22 | |||
23 | License and disclamer | ||
24 | ===================== | ||
25 | |||
26 | ekdosis – Typesetting TEI xml compliant critical editions | ||
27 | |||
28 | Copyright ⓒ 2020 Robert Alessi | ||
29 | |||
30 | Please send error reports and suggestions for improvements to Robert | ||
31 | Alessi: | ||
32 | |||
33 | - email: <alessi@robertalessi.net> | ||
34 | |||
35 | - website: <http://www.robertalessi.net/ekdosis> | ||
36 | |||
37 | - comments, feature requests, bug reports: | ||
38 | <https://gitlab.com/ralessi/ekdosis/issues> | ||
39 | |||
40 | This program is free software: you can redistribute it and/or modify it | ||
41 | under the terms of the GNU General Public License as published by the | ||
42 | Free Software Foundation, either version 3 of the License, or (at your | ||
43 | option) any later version. | ||
44 | |||
45 | This program is distributed in the hope that it will be useful, but | ||
46 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
47 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | ||
48 | Public License for more details. | ||
49 | |||
50 | You should have received a copy of the GNU General Public License along | ||
51 | with this program. If not, see <http://www.gnu.org/licenses/>. | ||
52 | |||
53 | This release of icite consists of the following source files: | ||
54 | |||
55 | - `ekdosis.dtx` | ||
56 | |||
57 | - `ekdosis.ins` | ||
58 | |||
59 | - `Makefile` | ||
60 | |||
61 | License applicable to the documentation | ||
62 | --------------------------------------- | ||
63 | |||
64 | Copyright ⓒ 2020 Robert Alessi | ||
65 | |||
66 | The documentation file `ekdosis.pdf` that is generated from the | ||
67 | `ekdosis.dtx` source file is licensed under the GNU Free Documentation | ||
68 | License, as follows:--- | ||
69 | |||
70 | Permission is granted to copy, distribute and/or modify this document | ||
71 | under the terms of the GNU Free Documentation License, Version 1.3 | ||
72 | or any later version published by the Free Software Foundation; with | ||
73 | no Invariant Sections, no Front-Cover Texts, and no Back-Cover | ||
74 | Texts. A copy of the license is included in the section entitled | ||
75 | “GNU Free Documentation License”. | ||
76 | |||
77 | Installation | ||
78 | ============ | ||
79 | |||
80 | 1. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and | ||
81 | `ekdosis.lua` files. | ||
82 | |||
83 | 2. To finish the installation you have to move the `ekdosis.sty` and | ||
84 | `ekdosis.lua` files into a directory where LaTeX can find it. See | ||
85 | the FAQ on `texfaq.org` at <https://texfaq.org/FAQ-inst-wlcf> for | ||
86 | |||
87 | |||
88 | Development, Git Repository | ||
89 | =========================== | ||
90 | |||
91 | Browse the code | ||
92 | --------------- | ||
93 | |||
94 | You can browse icite repository on the web: | ||
95 | <http://git.robertalessi.net/ekdosis> | ||
96 | |||
97 | From this page, you can download all the releases of `ekdosis`. For | ||
98 | instructions on how to install `ekdosis`, please see above. | ||
99 | |||
100 | Comments, Feature requests, Bug Reports | ||
101 | --------------------------------------- | ||
102 | |||
103 | <https://gitlab.com/ralessi/ekdosis/issues> | ||
104 | |||
105 | Download the repository | ||
106 | ----------------------- | ||
107 | |||
108 | `ekdosis` development is facilitated by git, a distributed version | ||
109 | control system. You will need to install git (most GNU/Linux | ||
110 | distributions package it in their repositories). | ||
111 | |||
112 | Use this command to download the repository | ||
113 | |||
114 | git clone http://git.robertalessi.net/ekdosis | ||
115 | |||
116 | A new directory named icite will have been created, containing | ||
117 | `ekdosis`. | ||
118 | |||
119 | Git hosting | ||
120 | ----------- | ||
121 | |||
122 | Make an account on <https://gitlab.com> and navigate (while logged in) | ||
123 | to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will | ||
124 | have in your account your own repository of `ekdosis` where you will | ||
125 | be able to make whatever changes you like to. | ||
126 | |||