[elpa] externals/org-remark 40d0e5fe39 2/4: ELPA - for now add README-elpa and full copyright/license notice

[ELPA Syncer]

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

    ELPA - for now add README-elpa and full copyright/license notice
---
 README-elpa         | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.org          |   8 ++--
 demo/custom-pens.el |  18 ++++++++
 3 files changed, 151 insertions(+), 4 deletions(-)

diff --git a/README-elpa b/README-elpa
new file mode 100644
index 0000000000..b23aaf58ee
--- /dev/null
+++ b/README-elpa
@@ -0,0 +1,129 @@
+                         _____________________
+
+                          README – ORG-REMARK
+                         _____________________
+
+
+Table of Contents
+_________________
+
+1. Introduction
+2. Installation
+3. Contributing and Feedback
+4. License
+
+
+
+
+
+1 Introduction
+==============
+
+  Org-remark lets you highlight and annotate any text file with using
+  Org mode.
+
+  A user manual is available [online] (Info node will be available when
+  Org-remark is added to ELPA/MELPA) or Emacs in-system as an Info node
+  `(org-remark)': (`C-h i' and find the `Org-remark' node).
+
+  For installation and minimum configuration, refer to [Installation]
+  below or the user manual: [online] or Info node `(org-remark)
+  Installation'
+
+  Getting Started in the user manual will get you started in 5 minutes:
+  [online] or or Info node `(org-remark) Getting Started'.
+
+  For customization, refer to the customization group `org-transclusion'
+  or user manual: [online] or Info node `(org-remark) Customizing'.
+
+  An [introductory video] (8 minutes) is available on YouTube.
+
+
+[online] <https://nobiot.github.io/org-remark/>
+
+[Installation] See section 2
+
+[online] <https://nobiot.github.io/org-remark/#Installation>
+
+[online] <https://nobiot.github.io/org-remark/#getting-started>
+
+[online] <https://nobiot.github.io/org-remark/#Customizing>
+
+[introductory video] <https://youtu.be/c8DHrAsFiLc>
+
+
+2 Installation
+==============
+
+  This package is not available on ELPA or MELPA yet. Manual
+  installation is required.
+
+  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.
+
+  Store all the `.el' files in the repo in your load-path and put this
+  in your init file:
+
+  ,----
+  | ;; 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)
+  `----
+
+  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.
+
+  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)
+  | (define-key global-map (kbd "C-c n m") #'org-remark-mark)
+  | 
+  | ;; The rest of keybidings are done only on loading `org-remark'
+  | (with-eval-after-load 'org-remark
+  |   (define-key org-remark-mode-map (kbd "C-c n o") #'org-remark-open)
+  |   (define-key org-remark-mode-map (kbd "C-c n ]") #'org-remark-view-next)
+  |   (define-key org-remark-mode-map (kbd "C-c n [") #'org-remark-view-prev)
+  |   (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove))
+  `----
+
+
+3 Contributing and Feedback
+===========================
+
+  Create issues, discussion, and/or pull requests in the GitHub
+  repository. All welcome.
+
+  Org-remark is planned to be submitted to GNU ELPA and thus copyrighted
+  by the [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" ([Org Mode website]).
+
+  Thank you.
+
+
+[Free Software Foundation] <http://fsf.org>
+
+[Org Mode website] <https://orgmode.org/contribute.html#copyright>
+
+
+4 License
+=========
+
+  This work is licensed under a GPLv3 license. For a full copy of the
+  license, refer to [LICENSE].
+
+
+[LICENSE] <./LICENSE>
diff --git a/README.org b/README.org
index 04b429e056..69b6cabcde 100644
--- a/README.org
+++ b/README.org
@@ -24,13 +24,13 @@ This feature is designed to work automatically and 
transparently to you, meaning
 
 Org-remark lets you highlight and annotate any text file with using Org mode.
 
-A user manual is available [[https://nobiot.github.io/org-remark/][online]] 
(Info node will be available when Org-remark is added to ELPA/MELPA).
+A user manual is available [[https://nobiot.github.io/org-remark/][online]] 
(Info node will be available when Org-remark is added to ELPA/MELPA) or Emacs 
in-system as an Info node `(org-remark)': (~C-h i~ and find the =Org-remark= 
node).
 
-For installation and minimum configuration, refer to 
[[#installation][Installation]] below or the user manual: 
[[https://nobiot.github.io/org-remark/#Installation][online]].
+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]].
+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]].
+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'.
 
 An [[https://youtu.be/c8DHrAsFiLc][introductory video]] (8 minutes) is 
available on YouTube.
 
diff --git a/demo/custom-pens.el b/demo/custom-pens.el
index 56a56e3468..5391f5d5bd 100644
--- a/demo/custom-pens.el
+++ b/demo/custom-pens.el
@@ -1,5 +1,23 @@
 ;; Copyright (C) 2021-2022  Free Software Foundation, Inc.
 
+;; Author: Noboru Ota <me@nobiot.com>
+
+;; This file is not part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
 (org-remark-create "memorize"
                    '(:foreground "white" :underline "black")
                    '(CATEGORY "exam"))