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

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

[nongnu] elpa/adoc-mode 1cbd1297be 137/199: Restructure the README a bit


From: ELPA Syncer
Subject: [nongnu] elpa/adoc-mode 1cbd1297be 137/199: Restructure the README a bit
Date: Sun, 3 Sep 2023 06:59:41 -0400 (EDT)

branch: elpa/adoc-mode
commit 1cbd1297be03925ec4afeecf91cf0f4e57c23c4f
Author: Bozhidar Batsov <bozhidar@batsov.dev>
Commit: Bozhidar Batsov <bozhidar@batsov.dev>

    Restructure the README a bit
---
 README.md | 65 +++++++++++++++++++++++++++++++--------------------------------
 1 file changed, 32 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index db478dcc2a..5b38ce57ec 100644
--- a/README.md
+++ b/README.md
@@ -17,12 +17,30 @@ final output. What must be bold is bold, what must be 
italic is italic etc.
 Meta characters are naturally still visible, but in a faint way, so they can
 be easily ignored.
 
+## Features
+
+Here are some of the main features of `adoc-mode`:
+
+- sophisticated highlighting
+- promote / demote title
+- toggle title type between one line title and two line title
+- adjust underline length of a two line title to match title text's length
+- goto anchor defining a given id, default reading from xref at point
+- support for outline (however only with the one-line title style)
+
+### Demo
+
+The highlighting emphasizes on how the output will look like. _All_
+characters are visible, however meta characters are displayed in a faint way.
+
+![screenshot](http://dl.dropbox.com/u/75789984/adoc-mode.png)
+
 ## Installation
 
 `adoc-mode` is available on the community-maintained
 [MELPA Stable][] and [MELPA][] repos.
 
-NonGNU ELPA and MELPA Stable are recommended as they have the latest stable 
version.
+Using MELPA Stable is recommended as it has the latest stable version.
 MELPA has a development snapshot for users who don't mind breakage but
 don't want to run `adoc-mode` from a git checkout.
 
@@ -30,48 +48,36 @@ You can install `adoc-mode` using the following command:
 
 <kbd>M-x package-install [RET] adoc-mode [RET]</kbd>
 
-or if you'd rather keep it in your Emacs config:
+If the installation doesn't work try refreshing the package list:
+
+<kbd>M-x package-refresh-contents</kbd>
+
+Alternative, you can add something like this to your Emacs config:
 
 ```emacs-lisp
 (unless (package-installed-p 'adoc-mode)
   (package-refresh-contents)
   (package-install 'adoc-mode))
-```
-
-If the installation doesn't work try refreshing the package list:
-
-<kbd>M-x package-refresh-contents</kbd>
 
+;; or if you're into use-package
+(use-package adoc-mode
+  :ensure t)
+```
 
 ## Configuration
 
-* According to an old AsciiDoc manual, .txt is the standard file extension of
+* According to an old AsciiDoc manual, `.txt` is the standard file extension of
   AsciiDoc files. Add the following to your initialization file to open all
-  .txt files with adoc-mode as major mode automatically: `(add-to-list
+  `.txt` files with adoc-mode as major mode automatically: `(add-to-list
   'auto-mode-alist (cons "\\.txt\\'" 'adoc-mode))`.
   More recent conventions for AsciiDoc file extensions include `.adoc` and
-  `.asciidoc`, these are associated automatically.
+  `.asciidoc`, these are associated with `adoc-mode` automatically.
 
 * If your default face is a fixed pitch (monospace) face, but in AsciiDoc
   files you liked to have normal text with a variable pitch face,
-  buffer-face-mode is for you: `(add-hook 'adoc-mode-hook (lambda()
+  `buffer-face-mode` is for you: `(add-hook 'adoc-mode-hook (lambda()
   (buffer-face-mode t)))`
 
-
-## Features
-
-- sophisticated highlighting
-
-- promote / demote title
-
-- toggle title type between one line title and two line title
-
-- adjust underline length of a two line title to match title text's length
-
-- goto anchor defining a given id, default reading from xref at point
-
-- support for outline (however only with the one-line title style)
-
 ### Coming features
 
 The next features I plan to implement
@@ -80,13 +86,6 @@ The next features I plan to implement
 - Outline support also for two line titles
 - Correctly highlighting backslash escapes
 
-## Screenshot
-
-The highlighting emphasizes on how the output will look like. _All_
-characters are visible, however meta characters are displayed in a faint way.
-
-![screenshot](http://dl.dropbox.com/u/75789984/adoc-mode.png)
-
 ## Hacking
 
 adoc-mode uses [Eldev](https://github.com/doublep/eldev) for development, so



reply via email to

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