emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/jinx 3e323c4713 3/5: Update README


From: ELPA Syncer
Subject: [elpa] externals/jinx 3e323c4713 3/5: Update README
Date: Sun, 26 Mar 2023 10:58:39 -0400 (EDT)

branch: externals/jinx
commit 3e323c4713b773140879957073b9032d6979cc79
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    Update README
---
 README.org | 17 +++++++++++------
 jinx.el    | 10 +++++-----
 2 files changed, 16 insertions(+), 11 deletions(-)

diff --git a/README.org b/README.org
index eb8c54f22f..3380d52595 100644
--- a/README.org
+++ b/README.org
@@ -12,9 +12,9 @@
 #+html: <a href="https://melpa.org/#/jinx";><img alt="MELPA" 
src="https://melpa.org/packages/jinx-badge.svg"/></a>
 #+html: <a href="https://stable.melpa.org/#/jinx";><img alt="MELPA Stable" 
src="https://stable.melpa.org/packages/jinx-badge.svg"/></a>
 
-Jinx provides just-in-time spell-checking checking via 
[[https://abiword.github.io/enchant/][libenchant]]. The package
-aims to achieve high performance and low resource usage, without impacting your
-editing experience. Overall Jinx should just work out of the box without much
+Jinx provides just-in-time spell-checking via 
[[https://abiword.github.io/enchant/][libenchant]]. The package aims to
+achieve high performance and low resource usage, without impacting your editing
+experience. Overall Jinx should just work out of the box without much
 intervention.
 
 Jinx highlights misspellings lazily only in the visible area of the window. 
Jinx
@@ -22,9 +22,7 @@ binds directly to the native libenchant API, such that 
process communication
 with a backend Aspell process can be avoided. Libenchant is widely used as
 spell-checking API by text editors and supports Nuspell, Hunspell, Aspell and a
 few lesser known backends. Jinx automatically compiles and loads the native
-module at startup. Libenchant must be available for compilation. If 
=pkg-config=
-is available it will be used to locate libenchant. On Debian or Ubuntu, install
-the packages =libenchant-2=, =libenchant-2-dev= and =pkg-config=.
+module at startup.
 
 Jinx supports multiple languages in a buffer at the same time via the
 =jinx-languages= customization variable. It offers flexible settings to ignore
@@ -32,6 +30,13 @@ misspellings via faces (=jinx-exclude-faces= and 
=jinx-include-faces=), regular
 expressions (=jinx-exclude-regexps=) and programmable predicates. Jinx comes
 preconfigured for the most important major modes.
 
+* Installation
+
+The package is available on GNU ELPA and MELPA and can be installed with
+=package-install=. Libenchant must be installed on your system for 
compilation. If
+=pkg-config= is available it will be used to locate libenchant. On Debian or
+Ubuntu, install the packages =libenchant-2=, =libenchant-2-dev= and 
=pkg-config=.
+
 * Usage
 
 Jinx offers three autoloaded entry points , the modes =global-jinx-mode=,
diff --git a/jinx.el b/jinx.el
index 75b2b5e7fc..e5573da941 100644
--- a/jinx.el
+++ b/jinx.el
@@ -24,7 +24,7 @@
 
 ;;; Commentary:
 
-;; Jinx provides just-in-time spell-checking checking via libenchant
+;; Jinx provides just-in-time spell-checking via libenchant
 ;; (https://abiword.github.io/enchant/).  The package aims to achieve
 ;; high performance and low resource usage, without impacting your
 ;; editing experience.  Overall Jinx should just work out of the box
@@ -36,10 +36,10 @@
 ;; avoided.  Libenchant is widely used as spell-checking API by text
 ;; editors and supports Nuspell, Hunspell, Aspell and a few lesser
 ;; known backends.  Jinx automatically compiles and loads the native
-;; module at startup.  Libenchant must be available for compilation.
-;; If `pkg-config' is available it will be used to locate libenchant.
-;; On Debian or Ubuntu, install the packages `libenchant-2',
-;; `libenchant-2-dev' and `pkg-config'.
+;; module at startup.  Libenchant must be installed on your system for
+;; compilation.  If `pkg-config' is available it will be used to
+;; locate libenchant.  On Debian or Ubuntu, install the packages
+;; `libenchant-2', `libenchant-2-dev' and `pkg-config'.
 ;;
 ;; Jinx supports multiple languages in a buffer at the same time via
 ;; the `jinx-languages' customization variable.  It offers flexible



reply via email to

[Prev in Thread] Current Thread [Next in Thread]