Main: update readme and notes in main.go

Author: rorycl

README.md

@@ -1,6 +1,6 @@
 # rm2pdf
 
-version 0.0.1-alpha
+version 0.0.2
 
 Convert reMarkable tablet file 'bundles' to layered PDFs, with optional
 per-layer colours for selected pens.
@@ -51,6 +51,8 @@ Some PDF files, notably those created by Microsoft Word, cannot be imported
 reliably, causing the programme to panic. Reprocessing problem PDFs with the
 `pdftk` tool seems to fix the problem.
 
+Note that rm2pdf has only been tested on a reMarkable v1 tablet.
+
 ## Background
 
 This is a holiday project to learn go. Error handling in particular is pretty
@@ -65,9 +67,12 @@ The project makes extensive use of the go PDF `fpdf` library and the contrib
 module `gofpdi`. The latter is used for including pages from existing PDF
 documents.
 
+If your pdf causes fpdf to fail, resave the pdf using the `pdftk`
+programme.
+
 ### Build and test
 
-Developed with go 1.13 on 64bit Linux.
+Developed with go 1.15 on 64bit Linux.
 
 Test:  `go test -v ./...`
 

main.go

@@ -2,15 +2,16 @@
 rm2pdf entry point
 
 MIT licensed, please see LICENCE
-RCL January 2020
+RCL 28 March 2021
 */
 
 package main
 
 import (
 	"fmt"
-	flags "github.com/jessevdk/go-flags"
 	"os"
+
+	flags "github.com/jessevdk/go-flags"
 	rmpdf "github.com/rorycl/rm2pdf/rmpdf"
 )
 
@@ -20,7 +21,7 @@ This programme attempts to create annotated PDF files from reMarkable
 tablet file groups (RM bundles), including .rm files recording marks.
 
 Normally these files will be in a local directory, such as an xochitl
-directory synchronised to a tablet over sshfs.
+directory synchronised to a reMarkable tablet over sshfs.
 
 The programme takes as input either:
 * The path to the PDF file which has had annotations made to it
@@ -44,12 +45,14 @@ Custom colours for some pens can be specified using the -c or --colours
 switch, which overrides the default pen selection. A second -c switch
 sets the colours on the second layer, and so on.
 
+Note that this programme has only been tested on a reMarkable v1 tablet.
+
 rm2pdf -t templates/A4.pdf \
        testfiles/d34df12d-e72b-4939-a791-5b34b3a810e7 /tmp/output.pdf
 
 rm2pdf [-v] [-c red] [-c green] [-c ...] `
 
-// flag options
+// Options are flag options
 type Options struct {
 	Verbose  bool                `short:"v" long:"verbose"  description:"show verbose output\nthis presently does not do much"`
 	Template string              `short:"t" long:"template" description:"path to a single page A4 template to use when no UUID.pdf exists\nuseful for processing sketches without a backing PDF"`