fix(README):Remove second title and clean up Usage
[BK-2020-04.git] / README.org
index 29f56f73cffe86ae44274ceb3b0e97050f324f30..ec42b2021b4e1ff5632d773a0d53801db338daaa 100644 (file)
@@ -1,12 +1,12 @@
 * BK-2020-04: Baltakatei Engineering Drawing Templates
-#+TITLE: BK-2020-04: Baltakatei Engineering Drawing Templates
 #+AUTHOR: Steven Baltakatei Sandoval
-#+DATE: 2023-05-23
+#+DATE: 2023-08-19
+#+EMAIL: baltakatei@gmail.com
 
 ** Scope
 This repository contains drawing files for constructing personal P&IDs
-(Process and Instrumentation Diagrams) and PFDs (Process Flow
-Diagrams).
+([[https://en.wikipedia.org/wiki/Piping_and_instrumentation_diagram][Piping and Instrumentation Diagrams]]) and PFDs ([[Process flow diagram][Process Flow
+Diagrams]]).
 
 ** Summary
 See the [[File:REVISION.org][drawing revision history]] for a list of tracked files.
@@ -20,14 +20,24 @@ Some drawings may be uploaded to Wikimedia Commons. Notable sets include:
 *** [[File:DEL][~DEL~]] : Deliverables
 May include drawings exported into PDF format.
 *** [[File:DWG][~DWG~]] : Drawing source files
-May include Inkscape SVG files.
+May include [[https://inkscape.org/][Inkscape]] SVG files.
 *** [[File:EXEC][~EXEC~]]: Executable files
 May include scripts useful for manipulating files.
 *** [[File:IMG][~IMG~]] : Reference image files
 May include various image files used in creation of project source
 files.
 
+** Usage
+*** Generate a combined PDF
+A script is available at ~./EXEC/combine_pdfs.sh~ to merge multiple
+single-page PDFs into a single PDF file; the script uses the [[https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/][~pdftk~
+utility]] available on typical [[https://www.debian.org/][Debian]]-based [[https://en.wikipedia.org/wiki/Gnu-Linux][GNU/Linux]] machines
+of 2023. On a typical Debian 12 system, the following command may be
+used to merge ~input1.pdf~ and ~input2.pdf~ files into ~output.pdf~.
+
+: $ /bin/bash combine_pdfs.sh output.pdf input1.pdf input2.pdf
+
 ** License
 Unless otherwise specified, source and deliverable files are copyright
-2023 [[http://baltakatei.com][Steven Baltakatei Sandoval]] and available under a [[https://creativecommons.org/licenses/by-sa/4.0/][CC BY-SA 4.0]]
+2023 [[https://baltakatei.com][Steven Baltakatei Sandoval]] and available under a [[https://creativecommons.org/licenses/by-sa/4.0/][CC BY-SA 4.0]]
 license.