branch: externals/doc-view-follow
commit ff22254e122179d6140ad9315bc5664fefb352e2
Author: Paul Nelson <ultr...@gmail.com>
Commit: Paul Nelson <ultr...@gmail.com>
update README
---
README.org | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.org b/README.org
index 5d286b5e95..e1f149a713 100644
--- a/README.org
+++ b/README.org
@@ -1,21 +1,21 @@
-#+title: doc-dual-view.el: Synchronized dual window document viewing
+#+title: doc-follow.el: Synchronized dual window document viewing
#+author: Paul Nelson
* Overview
-=doc-dual-view= is an Emacs package that synchronizes two windows showing the
same document in =doc-view-mode= or =pdf-view-mode= (with the list of available
modes customizable via =doc-dual-view-modes=). When you navigate to a page in
one window, the other window automatically displays the neighboring page,
giving a dual-page view.
+=doc-follow= is an Emacs package that synchronizes multiple windows showing
the same document in =doc-view-mode= or =pdf-view-mode= (with the list of
available modes customizable via =doc-follow-modes=). When you navigate to a
page in one window, the other windows automatically display neighboring pages.
A common setup is to have two pages side by side, in which case this mode gives
a book-like view.
* Installation
-Install =doc-dual-view= by, e.g., downloading the source and using =M-x
package-install-file=.
+Install =doc-follow= by, e.g., downloading the source and using =M-x
package-install-file=.
* Usage
-After installing the package, you can toggle it globally via =M-x
global-dual-doc-view-mode=, locally via =M-x doc-dual-view-mode=. To have it
activate by default, add =(global-dual-doc-view-mode)= to your config.
+After installing the package, you can toggle it globally via =M-x
global-dual-doc-view-mode=, locally via =M-x doc-follow-mode=. To have it
activate by default, add =(global-dual-doc-view-mode)= to your config.
1. Open a document in =doc-view-mode= or =pdf-view-mode= (the latter being
part of the [[https://github.com/vedang/pdf-tools][pdf-tools]] package)
2. Split the window (e.g., =C-x 3= for vertical split)
-3. Activate =doc-dual-view-mode= in either window (if not already activated)
+3. Activate =doc-follow-mode= in either window (if not already activated)
4. Navigate through the document in either window (e.g. =n= or =p= to navigate
by page)
-The package will automatically keep the two views in sync, with the second
always one page ahead of the first.
+The package will automatically keep the two views in sync, with the second
always one page ahead of the first. It works similarly with more than two
windows.
