Skip to content

Commit 1aea21f

Browse files
committed
Updated Readme, HowTo doc for the next release.
1 parent c8b6153 commit 1aea21f

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
![Screenshot](/docs/images/screenshot_alpha.png)
44

5-
I mostly read PDF documents on my Kindle and anyone who does the same, knows that highlights and
6-
notes taken on the Kindle are not saved on the PDF file itself. This presents a huge problem
7-
archiving my notes and to redo the highlights and copy the notes manually on to the PDF later on
8-
is not practical for me.
5+
I sometimes read PDF documents on my Kindle and anyone who does the same, knows that highlights and
6+
notes taken on the Kindle are not saved on the PDF file itself. This presents a huge problem
7+
archiving my notes and to redo the highlights and copy the notes manually on to the PDF later on
8+
is not practical for me.
99

10-
This software tries to provide a solution. kpdfsync reads the ‘My Clippings.txt’ text file for
11-
the highlights and notes and then applies them in the correct place on a PDF file.
10+
This software tries to provide a solution. **kpdfsync** reads the ‘My Clippings.txt’ text file for
11+
the highlights and notes and then applies them in the correct place on a PDF file.
1212

13-
Currently it is under development, so all the features may not work or be present.
14-
There can also be serious bugs present, so I request you to keep backup of the files you give to
15-
kpdfsync (the clippings file and pdf files)
13+
Currently it is **under development**, so all the features may not work or be present.
14+
There can also be serious bugs present, so I **request you to keep backup of the files you give to
15+
kpdfsync (the clippings file and pdf files)**.
1616

1717
Here is the rough roadmap of the development.
1818

@@ -35,7 +35,7 @@ Here is the rough roadmap of the development.
3535

3636
- [X] Bug Fixes
3737
- [X] Feature: Fixing common PDF errors.
38-
- [X] Documentation of the features.
38+
- [X] Usage guide for the end user.
3939
- [X] **Alpha Release 2**
4040

4141
----
@@ -55,6 +55,9 @@ Can probably work on macOS, but I do not own one, so not able to test.
5555
* Linux: poppler-utils
5656
* Windows: poppler-utils is included with the release.
5757

58+
**Note:** This is a new feature, which can resolve few of the PDF errors, but not all. New fixes
59+
will be added later on.
60+
5861
## 3rd-party License
5962

6063
* PDF Clown library is used to read and highlight on PDF files. PDF Clown library is covered under

docs/HowToSImplified.odt

-164 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)