tools/pdf: revise readme
This commit is contained in:
parent
335af41b70
commit
88b1d05a4a
1 changed files with 13 additions and 5 deletions
|
@ -16,7 +16,15 @@
|
||||||
- [[#troubleshooting][Troubleshooting]]
|
- [[#troubleshooting][Troubleshooting]]
|
||||||
|
|
||||||
* Description
|
* Description
|
||||||
This module improves Emacs' support for reading PDF files.
|
This module improves support for reading and interacting with PDF files in Emacs.
|
||||||
|
|
||||||
|
It uses =pdf-tools=, which is a replacement for the built-in ~doc-view-mode~ for
|
||||||
|
PDF files. The key difference being pages are not pre-rendered, but instead
|
||||||
|
rendered on-demand and stored in memory; a much faster approach, especially for
|
||||||
|
larger PDFs.
|
||||||
|
|
||||||
|
Displaying PDF files is just one function of =pdf-tools=. See [[https://github.com/politza/pdf-tools][its project
|
||||||
|
website]] for details and videos.
|
||||||
|
|
||||||
** Maintainers
|
** Maintainers
|
||||||
This module has no dedicated maintainers.
|
This module has no dedicated maintainers.
|
||||||
|
@ -28,12 +36,12 @@ This module provides no flags.
|
||||||
+ [[https://github.com/politza/pdf-tools][pdf-tools]]
|
+ [[https://github.com/politza/pdf-tools][pdf-tools]]
|
||||||
|
|
||||||
** Hacks
|
** Hacks
|
||||||
+ Added basic support for HiDPI or Retina displays.
|
+ Added out-of-the-box support for HiDPI or Retina displays.
|
||||||
|
|
||||||
* Prerequisites
|
* Prerequisites
|
||||||
This module will build the =epdfinfo= program when you first open a pdf file.
|
This module requires =epdfinfo=, a program the the =pdf-tools= plugin will build
|
||||||
Linux and macOS don't need to do anything special. Windows users, however, must
|
automatically when you open your first pdf file, unless you're on Windows.
|
||||||
build it themselves.
|
Windows users must build it themselves.
|
||||||
|
|
||||||
** Building =epdfinfo= on Windows
|
** Building =epdfinfo= on Windows
|
||||||
1. [[https://www.msys2.org/][Install MSYS2]] and update the package database and core packages using the
|
1. [[https://www.msys2.org/][Install MSYS2]] and update the package database and core packages using the
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue