[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/doc-toc 74c68f0cda 24/84: Update README.org
From: |
ELPA Syncer |
Subject: |
[elpa] externals/doc-toc 74c68f0cda 24/84: Update README.org |
Date: |
Mon, 26 Sep 2022 13:58:35 -0400 (EDT) |
branch: externals/doc-toc
commit 74c68f0cda6c692f9fce1ac0ad0613446ee934bd
Author: Daniel Nicolai <dalanicolai@gmail.com>
Commit: GitHub <noreply@github.com>
Update README.org
---
README.org | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index 0622a497af..11614ca079 100644
--- a/README.org
+++ b/README.org
@@ -21,13 +21,21 @@ level because the algorithm in the =toc-parse-djvused=
function does not parse
such files correctly yet (you are welcome to 'repair' the algorithm to produce
the correct syntax as it is described
[[http://djvu.sourceforge.net/doc/man/djvused.html#lbAW][on the djvused website
here]]).
+* Installation
-* Requirements
+For Spacemacs use the [[https://github.com/dalanicolai/toc-layer][toc-layer
for Spacemacs]]. Installation instruction are found on that page.
+
+For regular Emacs users, well... you probably know how to install packages.
+
+** Requirements
Currently the package requires the ~pdftotext~ (part of poppler-utils),
~pdfoutline~
(part of
[[https://launchpad.net/ubuntu/bionic/+package/fntsample][fntsample]]) and
~djvused~ (part of
[[http://djvu.sourceforge.net/][http://djvu.sourceforge.net/]]) command
line utilities to be available. Extraction with OCR requires the ~tesseract~
command
line utility to be available.
+
+
+
* Usage
Extraction and adding contents to a document is done in 4 steps:
1. extraction
- [elpa] externals/doc-toc eb8c6a0c00 56/84: Fix seq and cl compiler warnings, (continued)
- [elpa] externals/doc-toc eb8c6a0c00 56/84: Fix seq and cl compiler warnings, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 05b6d034aa 59/84: Fix djvu/pdf hard dependency (github issue #3), ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 8d4817a543 62/84: Fix org-noter conflict (github #4), ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc a14dbb4c25 67/84: Fix beginning-of-buffer compilation warning, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 102e14199c 65/84: pdf.tocgen replace original pdf, and show message on fail, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 4c9ce0f54d 76/84: Fix: eval-when-compile pdf-tools, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 2ec9515f0d 81/84: Apply patch S. Monnier, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc ca80abf2f8 83/84: Update name to doc-toc (i.e. make doc-tools extension), ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 3d286633a9 11/84: Update README, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 3acf45b0f7 18/84: Implement C-c C-c functionality also for djvu, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 74c68f0cda 24/84: Update README.org,
ELPA Syncer <=
- [elpa] externals/doc-toc f8fbca0c41 23/84: README add features and keybindings, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc f643745b06 32/84: Set windows encoding for djvu, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc c521029525 36/84: Change (beginning-og-buffer) to (goto-char (point-min)) for MELPA, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc a1d26eceb5 37/84: Add defvar and declare-function to avoid warning MELPA, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 05cd1287f1 42/84: Fix toc--add-to-djvu. Don't ask save location., ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc f430243a88 43/84: Add version: 0 header, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 59f4471e6a 50/84: Update README.org, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 2d95c466a3 48/84: Add MELPA and GPL3 badges, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 734043bdc7 47/84: Improve documentation in toc-mode.el, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc ae455b4863 52/84: Implement language customization for OCR, ELPA Syncer, 2022/09/26