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