Skip to content

Commit f3f5488

Browse files
committed
docs: update README for 0.1.4 release
1 parent 55517ca commit f3f5488

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
# rm2pdf
22

3-
version 0.1.4 : 21 September 2022
3+
version 0.1.4 : 24 September 2022
44

55
Convert reMarkable tablet file 'bundles' to layered PDFs, with optional
66
per-layer colours for selected pens.
77

88
## Update
99

10-
15 September 2022
10+
24 September 2022
11+
12+
Add rmapi zip file support
1113

1214
This 0.1.4 release adds support for rmapi zip files. As directory and
1315
zip file support is through go's `fs.FS` (hierarchical file system)
1416
module, further ways of mounting filesystems, such as through ssh,
1517
should be possible.
1618

19+
`rm2pdf path_to.zip output.pdf`
20+
1721
Note that go 1.16+ is needed for `rm2pdf` due to the use of embedded
1822
files, added in v0.1.3.
1923

@@ -61,16 +65,27 @@ Arguments:
6165
Invocation examples for annotated PDFs using the test files in `testfiles`:
6266

6367
```
64-
rm2pdf testfiles/cc8313bb-5fab-4ab5-af39-46e6d4160df3.pdf /tmp/output.pdf
65-
rm2pdf -c orange -c olivegreen testfiles/cc8313bb-5fab-4ab5-af39-46e6d4160df3.pdf /tmp/output2.pdf
68+
rm2pdf testfiles/cc8313bb-5fab-4ab5-af39-46e6d4160df3.pdf output.pdf
69+
70+
rm2pdf -c orange -c olivegreen \
71+
testfiles/cc8313bb-5fab-4ab5-af39-46e6d4160df3.pdf output2.pdf
6672
```
6773

6874
Invocation examples for reMarkable notebooks using the test files in `testfiles`
6975
and the A4 template in `templates`.
7076

7177
```
72-
rm2pdf -t templates/A4.pdf testfiles/d34df12d-e72b-4939-a791-5b34b3a810e7 /tmp/output3.pdf
73-
rm2pdf -c blue -c red -t templates/A4.pdf testfiles/d34df12d-e72b-4939-a791-5b34b3a810e7 /tmp/output4.pdf
78+
rm2pdf -c blue -c red -t templates/A4.pdf \
79+
testfiles/d34df12d-e72b-4939-a791-5b34b3a810e7 output4.pdf
80+
81+
```
82+
83+
The embedded template is used where one is not provided, so the above command is
84+
the same as
85+
86+
```
87+
rm2pdf -c blue -c red \
88+
testfiles/d34df12d-e72b-4939-a791-5b34b3a810e7 output4.pdf
7489
```
7590

7691
## Details
@@ -89,12 +104,11 @@ Output PDFs are layered with the background PDF forming a "Background" layer and
89104
subsequent layers using the layer names created on the tablet. The layers can be
90105
turned on and off using tools provided by PDF readers such as Evince.
91106

92-
The pen widths and opacities are estimates and could be improved. The .rm file
93-
pressure and tilt information is not presently used.
94-
95-
Colours, base width and opacity are set for each pen are set in rmpdf/stroke.go.
96-
Those pens with ColourOverride true will have their colour overridden by the
97-
command-line options.
107+
The pen widths and opacities provided by default are estimates. Colours, base
108+
width and opacity are set for each pen are set in rmpdf/stroke.go. Those pens
109+
with ColourOverride true will have their colour overridden by the command-line
110+
options or pen configuration yaml file. Note that at present the .rm file
111+
pressure and tilt information are not presently used.
98112

99113
Some PDF files, notably those created by Microsoft Word, cannot be imported
100114
reliably, causing the programme to panic. Reprocessing problem PDFs with the

0 commit comments

Comments
 (0)