Skip to content

Commit f700ac8

Browse files
author
rorycl
committed
Main: update readme and notes in main.go
1 parent acee25c commit f700ac8

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# rm2pdf
22

3-
version 0.0.1-alpha
3+
version 0.0.2
44

55
Convert reMarkable tablet file 'bundles' to layered PDFs, with optional
66
per-layer colours for selected pens.
@@ -51,6 +51,8 @@ Some PDF files, notably those created by Microsoft Word, cannot be imported
5151
reliably, causing the programme to panic. Reprocessing problem PDFs with the
5252
`pdftk` tool seems to fix the problem.
5353

54+
Note that rm2pdf has only been tested on a reMarkable v1 tablet.
55+
5456
## Background
5557

5658
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
6567
module `gofpdi`. The latter is used for including pages from existing PDF
6668
documents.
6769

70+
If your pdf causes fpdf to fail, resave the pdf using the `pdftk`
71+
programme.
72+
6873
### Build and test
6974

70-
Developed with go 1.13 on 64bit Linux.
75+
Developed with go 1.15 on 64bit Linux.
7176

7277
Test: `go test -v ./...`
7378

main.go

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22
rm2pdf entry point
33
44
MIT licensed, please see LICENCE
5-
RCL January 2020
5+
RCL 28 March 2021
66
*/
77

88
package main
99

1010
import (
1111
"fmt"
12-
flags "github.com/jessevdk/go-flags"
1312
"os"
13+
14+
flags "github.com/jessevdk/go-flags"
1415
rmpdf "github.com/rorycl/rm2pdf/rmpdf"
1516
)
1617

@@ -20,7 +21,7 @@ This programme attempts to create annotated PDF files from reMarkable
2021
tablet file groups (RM bundles), including .rm files recording marks.
2122
2223
Normally these files will be in a local directory, such as an xochitl
23-
directory synchronised to a tablet over sshfs.
24+
directory synchronised to a reMarkable tablet over sshfs.
2425
2526
The programme takes as input either:
2627
* 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
4445
switch, which overrides the default pen selection. A second -c switch
4546
sets the colours on the second layer, and so on.
4647
48+
Note that this programme has only been tested on a reMarkable v1 tablet.
49+
4750
rm2pdf -t templates/A4.pdf \
4851
testfiles/d34df12d-e72b-4939-a791-5b34b3a810e7 /tmp/output.pdf
4952
5053
rm2pdf [-v] [-c red] [-c green] [-c ...] `
5154

52-
// flag options
55+
// Options are flag options
5356
type Options struct {
5457
Verbose bool `short:"v" long:"verbose" description:"show verbose output\nthis presently does not do much"`
5558
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"`

0 commit comments

Comments
 (0)