branch: elpa/adoc-mode
commit 1083ba1c2e4c72de0eb968dd4c630f4eb3bb9664
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Document the AsciiDoc spec-compatibility goal
Note in the README and the package commentary that adoc-mode aims to be
fully compatible with the modern official AsciiDoc language specification,
and link to doc/spec-compliance.adoc which tracks our progress.
---
README.adoc | 5 +++++
adoc-mode.el | 5 +++++
2 files changed, 10 insertions(+)
diff --git a/README.adoc b/README.adoc
index fb6b1eeb6a..b15d9886ea 100644
--- a/README.adoc
+++ b/README.adoc
@@ -30,6 +30,11 @@ 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.
+`adoc-mode` aims to be fully compatible with the modern official
+https://gitlab.eclipse.org/eclipse/asciidoc-lang/asciidoc-lang[AsciiDoc
language specification]
+developed under the Eclipse AsciiDoc Working Group. You can follow our
+progress toward that goal in link:doc/spec-compliance.adoc[the spec-compliance
document].
+
== Features
Here are some of the main features of `adoc-mode`:
diff --git a/adoc-mode.el b/adoc-mode.el
index 5359ab6636..c5c48ae62c 100644
--- a/adoc-mode.el
+++ b/adoc-mode.el
@@ -39,6 +39,11 @@
;; 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.
+;;
+;; adoc-mode aims to be fully compatible with the modern official AsciiDoc
+;; language specification developed under the Eclipse AsciiDoc Working Group
+;; (https://gitlab.eclipse.org/eclipse/asciidoc-lang/asciidoc-lang). Progress
+;; toward that goal is tracked in doc/spec-compliance.adoc.
;;; Code:
