Closed blattms closed 6 months ago
Great, this looks good. Some minor suggestions for improvements to the text:
diff --git a/README.md b/README.md
index dd206d9..accb8be 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,32 @@
# The OPM-flow reference manual
This repository contains the uncompressed LibreOffice XML files (ending in
-.fdot) used for creating the reference manual of flow
+`.fodt`) used for creating the reference manual of flow.
## Structure of the documents.
To make the rather large manual feasible to edit on most systems, the document
-is organized as a master document (part/main.fodt) which contains links to many
+is organized as a master document (`part/main.fodt`) which contains links to many
other LibreOffice documents that contain the individual parts.
-Each chapter is in its own document (e.g. parts/chapters/1.fdot for the first
+Each chapter is in its own document (e.g. `parts/chapters/1.fodt` for the first
chapter). The same holds for the chapters of the appendices (e.g
-parts/appendices/A.fdot for Appendix A).
+`parts/appendices/A.fodt` for Appendix A).
Many of the chapter files contain themselves links to external documents. Those
-are representing sections (e.g. parts/chapters/sections/4/3.fodt for section
-4.3 that is linked to from parts/chapters/4).
+are representing sections (e.g. `parts/chapters/sections/4/2.fodt` for section
+4.2 that is linked to from `parts/chapters/4.fodt`).
The special subsections (4.3, 5.3, 6.3, 7.3, 8.3, 9.3, 10.3, 11.3, and 12.3)
contain all the descriptions of the keywords supported or not supported by
flow. Each keyword is described in its
own LibreOffice file and referenced as an external link in the subsection file.
-An example of such a file is parts/chapters/subsections/4.3/COLUMNS.fodt.
+An example of such a file is `parts/chapters/subsections/4.3/COLUMNS.fodt`.
## Editing the manual
-Note that any document containing link to external documents should never be
-edited directly. If such a document would be saved then LibreOffice would
+Note that any document containing links to external documents should never be
+edited directly. If such a document should be saved then LibreOffice would
remove all the links to the external documents and instead embed those documents
into the document that is edited. This would break the above described
structure.
@@ -42,7 +42,7 @@ and click the "Export" button in the dialog, then choose a filename for the PDF
## Further information
-For further information please see the following READMEs
+For further information please see the following READMEs:
- [fonts/README.md](fonts/README.md) for information about how to display the
documents correctly with the correct fonts (e.g. using docker)
- [scripts/README.md](scripts/README.md) for information about the scripts
Thanks for the comments. I did all changes except the change from would to should.
Thanks!
This was on my list for a very long time. Sorry that this took so long. Once this is merged we can finally make the repo public at last.