[elpa] externals/org-remark 3877835e99: docs: Update availability on ELPA

[ELPA Syncer]

branch: externals/org-remark
commit 3877835e9971d66bb7e59b0e176ede17a57975a1
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    docs: Update availability on ELPA
---
 README-elpa         | 38 +++++++++++++++++++++++---------------
 README.org          | 34 ++++++++++++++++++----------------
 docs/org-remark.org | 28 +++++++++++++++-------------
 3 files changed, 56 insertions(+), 44 deletions(-)

diff --git a/README-elpa b/README-elpa
index b23aaf58ee..02cfdb3ad4 100644
--- a/README-elpa
+++ b/README-elpa
@@ -55,20 +55,25 @@ _________________
 2 Installation
 ==============
 
-  This package is not available on ELPA or MELPA yet. Manual
-  installation is required.
+  This package is available on:
 
-  Ensure to have Org Mode 9.4 or later (tested on 9.4.2). This package
-  uses `org-collect-keywords', which does not exist in an earlier
-  version.
+  - [GNU ELPA] (releases only; equivalent to MELPA-Stable)
+  - [GNU-devel ELPA] (unreleased development branch; equivalent to
+    MELPA)
 
-  Store all the `.el' files in the repo in your load-path and put this
-  in your init file:
+  GNU ELPA should be already set up in your Emacs by default. If you
+  wish to add GNU-devel ELPA, simply add its URL to `package-archives'
+  like this:
+
+  ,----
+  | (add-to-list 'package-archives
+  |         '("gnu-devel" . "https://elpa.gnu.org/devel/";) :append)
+  `----
+
+  After installation, we suggest you put the setup below in your
+  configuration.
 
   ,----
-  | ;; Set `load-path' , load `org-remark-global-tracking', and turn it on for
-  | ;; automatic loading of highlights for the files tracked
-  | (add-to-list 'load-path "~/local-repos/org-remark")
   | (require 'org-remark-global-tracking)
   | (org-remark-global-tracking-mode +1)
   `----
@@ -83,11 +88,9 @@ _________________
   Below are example keybindings you might like to consider:
 
   ,----
-  | ;; Key-bind `org-remark-mark' to global-map so that you can call it 
globally
-  | ;; before the library is loaded.  In order to make `org-remark-mark' and
-  | ;; `org-remark-mode' callable, use `autoload'.
-  | (autoload #'org-remark-mark "org-remark" nil t)
-  | (autoload #'org-remark-mode "org-remark" nil t)
+  | ;; Key-bind `org-remark-mark' to global-map so that you can call it
+  | ;; globally before the library is loaded.
+  | 
   | (define-key global-map (kbd "C-c n m") #'org-remark-mark)
   | 
   | ;; The rest of keybidings are done only on loading `org-remark'
@@ -99,6 +102,11 @@ _________________
   `----
 
 
+[GNU ELPA] <https://elpa.gnu.org/packages/org-remark.html>
+
+[GNU-devel ELPA] <https://elpa.gnu.org/devel/org-remark.html>
+
+
 3 Contributing and Feedback
 ===========================
 
diff --git a/README.org b/README.org
index 69b6cabcde..9de47deb53 100644
--- a/README.org
+++ b/README.org
@@ -10,7 +10,7 @@
 
 Happy 2022!
 
-I have changed the name of the project and package to "*Org-remark*" from 
Org-marginalia. 
+I have changed the name of the project and package to "*Org-remark*" from 
Org-marginalia.
 
 If you are using Org-marginalia now, there are breaking changes. This package 
includes the feature that automatically converts the old Org-marginalia data 
into the new Org-remark data. Add ~org-remark-convert-legacy~ feature like this:
 
@@ -18,7 +18,7 @@ If you are using Org-marginalia now, there are breaking 
changes. This package in
   (require 'org-remark-convert-legacy)
 #+end_src
 
-This feature is designed to work automatically and transparently to you, 
meaning you should not have to do anything, as long as you did not customize 
~org-marginala-notes-file-path~. If you did, you also need to customize 
~org-remark-notes-file-path~. You can also manually do data conversion if you 
wish. For more detail, refer to the docstring of function 
~org-remark-convert-legacy-data~. 
+This feature is designed to work automatically and transparently to you, 
meaning you should not have to do anything, as long as you did not customize 
~org-marginala-notes-file-path~. If you did, you also need to customize 
~org-remark-notes-file-path~. You can also manually do data conversion if you 
wish. For more detail, refer to the docstring of function 
~org-remark-convert-legacy-data~.
 
 * Introduction
 
@@ -28,7 +28,7 @@ A user manual is available 
[[https://nobiot.github.io/org-remark/][online]] (Inf
 
 For installation and minimum configuration, refer to 
[[#installation][Installation]] below or the user manual: 
[[https://nobiot.github.io/org-remark/#Installation][online]] or Info node 
`(org-remark) Installation'
 
-Getting Started in the user manual will get you started in 5 minutes: 
[[https://nobiot.github.io/org-remark/#getting-started][online]] or or Info 
node `(org-remark) Getting Started'. 
+Getting Started in the user manual will get you started in 5 minutes: 
[[https://nobiot.github.io/org-remark/#getting-started][online]] or or Info 
node `(org-remark) Getting Started'.
 
 For customization, refer to the customization group `org-transclusion' or user 
manual: [[https://nobiot.github.io/org-remark/#Customizing][online]] or Info 
node `(org-remark) Customizing'.
 
@@ -50,17 +50,21 @@ An [[https://youtu.be/c8DHrAsFiLc][introductory video]] (8 
minutes) is available
 :CUSTOM_ID: installation
 :END:
 
-This package is not available on ELPA or MELPA yet. Manual installation is 
required.
+This package is available on:
 
-Ensure to have Org Mode 9.4 or later (tested on 9.4.2). This package uses 
~org-collect-keywords~, which does not exist in an earlier version.
+- [[https://elpa.gnu.org/packages/org-remark.html][GNU ELPA]] (releases only; 
equivalent to MELPA-Stable)
+- [[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] (unreleased 
development branch; equivalent to MELPA)
 
-Store all the =.el= files in the repo in your load-path and put this in your
-init file:
+GNU ELPA should be already set up in your Emacs by default. If you wish to add 
GNU-devel ELPA, simply add its URL to ~package-archives~ like this:
+
+#+BEGIN_SRC elisp
+  (add-to-list 'package-archives
+               '("gnu-devel" . "https://elpa.gnu.org/devel/";) :append)
+#+END_SRC
+
+After installation, we suggest you put the setup below in your configuration.
 
 #+begin_src emacs-lisp
-  ;; Set `load-path' , load `org-remark-global-tracking', and turn it on for
-  ;; automatic loading of highlights for the files tracked
-  (add-to-list 'load-path "~/local-repos/org-remark")
   (require 'org-remark-global-tracking)
   (org-remark-global-tracking-mode +1)
 #+end_src
@@ -70,11 +74,9 @@ Unless you explicitly load ~org~ during Emacs 
initialization, I suggest to defer
 Below are example keybindings you might like to consider:
 
 #+begin_src emacs-lisp
-  ;; Key-bind `org-remark-mark' to global-map so that you can call it globally
-  ;; before the library is loaded.  In order to make `org-remark-mark' and
-  ;; `org-remark-mode' callable, use `autoload'.
-  (autoload #'org-remark-mark "org-remark" nil t)
-  (autoload #'org-remark-mode "org-remark" nil t)
+  ;; Key-bind `org-remark-mark' to global-map so that you can call it
+  ;; globally before the library is loaded.
+
   (define-key global-map (kbd "C-c n m") #'org-remark-mark)
 
   ;; The rest of keybidings are done only on loading `org-remark'
@@ -92,7 +94,7 @@ Create issues, discussion, and/or pull requests in the GitHub 
repository. All we
 Org-remark is planned to be submitted to GNU ELPA and thus copyrighted by the 
[[http://fsf.org][Free Software Foundation]] (FSF). This means that anyone who 
is making a substantive code contribution will need to "assign the copyright 
for your contributions to the FSF so that they can be included in GNU Emacs" 
([[https://orgmode.org/contribute.html#copyright][Org Mode website]]).
 
 Thank you.
-   
+
 * License
 
 This work is licensed under a GPLv3 license. For a full copy of the license, 
refer to [[./LICENSE][LICENSE]].
diff --git a/docs/org-remark.org b/docs/org-remark.org
index 1771703086..e3e6986d0a 100644
--- a/docs/org-remark.org
+++ b/docs/org-remark.org
@@ -42,31 +42,33 @@ modify this GNU manual.”
 :CUSTOM_ID: installation
 :END:
 
-This package is not available on ELPA or MELPA yet. Manual installation is 
required.
+This package is available on:
 
-Ensure to have Org Mode 9.4 or later (tested on 9.4.2). This package uses 
~org-collect-keywords~, which does not exist in an earlier version.
+- [[https://elpa.gnu.org/packages/org-remark.html][GNU ELPA]] (releases only; 
equivalent to MELPA-Stable)
+- [[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] (unreleased 
development branch; equivalent to MELPA)
 
-Store all the ~.el~ files in the repo in your load-path and put this in your
-init file:
+GNU ELPA should be already set up in your Emacs by default. If you wish to add 
GNU-devel ELPA, simply add its URL to ~package-archives~ like this:
+
+#+BEGIN_SRC elisp
+  (add-to-list 'package-archives
+               '("gnu-devel" . "https://elpa.gnu.org/devel/";) :append)
+#+END_SRC
+
+After installation, we suggest you put the setup below in your configuration.
 
 #+begin_src emacs-lisp
-  ;; Set `load-path' , load `org-remark-global-tracking', and turn it on for
-  ;; automatic loading of highlights for the files tracked
-  (add-to-list 'load-path "~/local-repos/org-remark")
   (require 'org-remark-global-tracking)
   (org-remark-global-tracking-mode +1)
 #+end_src
 
-Unless you explicitly load ~org~ during Emacs initialization, I suggest to 
defer loading ~org-remark~ (thus there is no ~(require 'org-remark)~ in the 
example above). This is because it will also pull in ~org~, which can slow down 
initialization. You can control the timing of loading ~org-remark~ by 
autoloading some commands in a similar way with the example keybindings below.
+Unless you explicitly load ~org~ during Emacs initialization, we suggest to 
defer loading ~org-remark~ (thus there is no ~(require 'org-remark)~ in the 
example above). This is because it will also pull in ~org~, which can slow down 
initialization. You can control the timing of loading ~org-remark~ by 
autoloading some commands in a similar way with the example keybindings below.
 
 Below are example keybindings you might like to consider:
 
 #+begin_src emacs-lisp
-  ;; Key-bind `org-remark-mark' to global-map so that you can call it globally
-  ;; before the library is loaded.  In order to make `org-remark-mark' and
-  ;; `org-remark-mode' callable, use `autoload'.
-  (autoload #'org-remark-mark "org-remark" nil t)
-  (autoload #'org-remark-mode "org-remark" nil t)
+  ;; Key-bind `org-remark-mark' to global-map so that you can call it
+  ;; globally before the library is loaded.
+
   (define-key global-map (kbd "C-c n m") #'org-remark-mark)
 
   ;; The rest of keybidings are done only on loading `org-remark'