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

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

[elpa] externals/org-transclusion 4074b9c0d9 1/4: docs:Installation: add


From: ELPA Syncer
Subject: [elpa] externals/org-transclusion 4074b9c0d9 1/4: docs:Installation: add instruction for ELPA-devel
Date: Sun, 26 Dec 2021 05:57:50 -0500 (EST)

branch: externals/org-transclusion
commit 4074b9c0d9f565641708350f48264dc05e2844b1
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    docs:Installation: add instruction for ELPA-devel
---
 README.org | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/README.org b/README.org
index 1de764dd14..b8a1321776 100644
--- a/README.org
+++ b/README.org
@@ -80,15 +80,24 @@ Main Features:
 :CUSTOM_ID: installation
 :END:
 
-This package is available on 
[[https://elpa.gnu.org/packages/org-transclusion.html][GNU ELPA]]. You can do 
=M-x package-install RET
-org-transclusion= to install it.  After installation, you can start using
-Org-transclusion.
+This package is available on:
+
+- [[https://elpa.gnu.org/packages/org-transclusion.html][GNU ELPA]] (releases 
only; equivalent to MELPA-Stable)
+- [[https://elpa.gnu.org/devel/org-transclusion.html][GNU-devel ELPA]] 
(unreleased development branch; equivalent to MELPA)
 
-Below are some example keybindings that can be put into your Emacs 
configuration.
+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
-(define-key global-map (kbd "<f12>") #'org-transclusion-add)
-(define-key global-map (kbd "C-n t") #'org-transclusion-mode)
+  (add-to-list 'package-archives '("gnu-devel" . 
"https://elpa.gnu.org/devel/";) t)
+#+END_SRC
+
+Refresh the archive with =M-x package-refresh-contents RET= and you can do 
=M-x package-install RET org-transclusion= to install it. Alternatively, you 
can use =package-list-packages=. 
+
+After installation, you can start using Org-transclusion with no additional 
configuration. Below are some example keybindings that can be put into your 
Emacs configuration.
+
+#+BEGIN_SRC elisp
+  (define-key global-map (kbd "<f12>") #'org-transclusion-add)
+  (define-key global-map (kbd "C-n t") #'org-transclusion-mode)
 #+END_SRC
 
 For Doom users, you would need to do something like this below to install the 
package and configure the keybindings. 
@@ -111,6 +120,7 @@ For Doom users, you would need to do something like this 
below to install the pa
 #+END_SRC
 
 * Contributing
+
 - Get involved in a discussion in 
[[https://org-roam.discourse.group/t/prototype-transclusion-block-reference-with-emacs-org-mode/830][Org-roam
 forum]] (the package is originally aimed for its users, me included)
 
 - Create issues, discussion, and/or pull requests. All welcome.
@@ -120,4 +130,5 @@ Org-transclusion is part of GNU ELPA and thus copyrighted 
by the [[http://fsf.or
 Thank you.
 
 * License
+
 Org-transclusion is licensed under a GPLv3 license. For a full copy of the 
license, refer to [[./LICENSE][LICENSE]].



reply via email to

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