Browse Source

note dependencies

Daniel Sheffield 2 years ago
parent
commit
9771847cf3
1 changed files with 12 additions and 4 deletions
  1. 12 4
      Readme.md

+ 12 - 4
Readme.md

@@ -6,8 +6,6 @@ This approach just takes some prepared files and collates them into the desired
 
 While a certain layout is assumed during collation, any periodic layout will work with a bit of hacking.
 
-# Usage
-
 The layout used here is as follows:
 
 * Title Page (1 page)
@@ -19,10 +17,18 @@ Everything repeated except for the title page of course.
 
 Designed for double sided printing so that the bi-weekly planner is on facing pages.
 
-These pages can be Open Document format, or pdf.
-
 Providing your own documents to get the typesetting you want.
 
+# Installation
+
+Needs ``bash``, ``pdftk``, ``ps2pdf``, ``pcal``, and optionally ``libreoffice``.
+
+* LibreOffice is only required to print any Open Documents as pdf.
+
+Everything is processed through ``pdftk`` - with some heavy usage of bash substitution.
+
+# Usage
+
 ```
 ./gardening-calendar.sh -h # for help
 
@@ -45,6 +51,8 @@ Single page LibreOffice text document: ``title.fodt``
 
 Single page (ish) ODT document with ruled lines and a rainfall table: ``ruled-rainfall.fodt``
 
+If more than one page, only the first page is used.
+
 ## Bi-Weekly planner
 
 This is more complex.