[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/embark 810544f: Add section on contributions to README
From: |
ELPA Syncer |
Subject: |
[elpa] externals/embark 810544f: Add section on contributions to README and manual |
Date: |
Tue, 2 Nov 2021 12:57:19 -0400 (EDT) |
branch: externals/embark
commit 810544f9fcb8e0ddf0d9b89682c208e2127f8f13
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>
Add section on contributions to README and manual
Also: mention GNU ELPA.
---
README.org | 23 ++++++++++++++++++-----
embark.texi | 25 ++++++++++++++++++++-----
2 files changed, 38 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index 3c8b04c..4f51b85 100644
--- a/README.org
+++ b/README.org
@@ -216,11 +216,12 @@ switch to =find-file=.
* Quick start
-The easiest way to install Embark is from Melpa. It is highly
-recommended to also install
[[https://github.com/minad/marginalia][Marginalia]], so that Embark can offer
you
-preconfigured actions in more contexts. For =use-package= users that
-add Melpa to their =package-archives=, the following is a very
-reasonable starting configuration:
+The easiest way to install Embark is from GNU ELPA, just run =M-x
+package-install RET embark RET=. (It is also available on MELPA.) It is
+highly recommended to also install
[[https://github.com/minad/marginalia][Marginalia]] (also available on GNU
+ELPA), so that Embark can offer you preconfigured actions in more
+contexts. For =use-package= users, the following is a very reasonable
+starting configuration:
#+begin_src emacs-lisp
(use-package marginalia
@@ -767,6 +768,18 @@ And some videos to watch:
- [[https://youtu.be/5ffb2at2d7w][Using Emacs Episode 80 - Vertico,
Marginalia, Consult and Embark]] by
Mike Zamansky.
+* Contributions
+
+Contributions to Embark are very welcome. There is a
[[https://github.com/oantolin/embark/issues/95][wish list]] for
+actions, target finders, candidate collectors and exporters. For other
+ideas you have for Embark, feel free to open an issue on the
[[https://github.com/oantolin/embark/issues][issue
+tracker]]. Any neat configuration tricks you find might be a good fit
+for the [[https://github.com/oantolin/embark/wiki][wiki]].
+
+Code contributions are very welcome too, but since Embark is now on
+GNU ELPA, copyright assignment to the FSF is required before you can
+contribute code.
+
* Acknowledgements
While I, Omar Antolín Camarena, have written most of the Embark code
diff --git a/embark.texi b/embark.texi
index 6b6bcc2..e114e45 100644
--- a/embark.texi
+++ b/embark.texi
@@ -31,6 +31,7 @@
* How does Embark call the actions?::
* Embark, Marginalia and Consult: Embark Marginalia and Consult.
* Resources::
+* Contributions::
* Acknowledgements::
@detailmenu
@@ -303,11 +304,12 @@ switch to @samp{find-file}.
@node Quick start
@chapter Quick start
-The easiest way to install Embark is from Melpa. It is highly
-recommended to also install @uref{https://github.com/minad/marginalia,
Marginalia}, so that Embark can offer you
-preconfigured actions in more contexts. For @samp{use-package} users that
-add Melpa to their @samp{package-archives}, the following is a very
-reasonable starting configuration:
+The easiest way to install Embark is from GNU ELPA, just run @samp{M-x
+package-install RET embark RET}. (It is also available on MELPA@.) It is
+highly recommended to also install @uref{https://github.com/minad/marginalia,
Marginalia} (also available on GNU
+ELPA), so that Embark can offer you preconfigured actions in more
+contexts. For @samp{use-package} users, the following is a very reasonable
+starting configuration:
@lisp
(use-package marginalia
@@ -926,6 +928,19 @@ message} by Sacha Chua.
Mike Zamansky.
@end itemize
+@node Contributions
+@chapter Contributions
+
+Contributions to Embark are very welcome. There is a
@uref{https://github.com/oantolin/embark/issues/95, wish list} for
+actions, target finders, candidate collectors and exporters. For other
+ideas you have for Embark, feel free to open an issue on the
@uref{https://github.com/oantolin/embark/issues, issue
+tracker}. Any neat configuration tricks you find might be a good fit
+for the @uref{https://github.com/oantolin/embark/wiki, wiki}.
+
+Code contributions are very welcome too, but since Embark is now on
+GNU ELPA, copyright assignment to the FSF is required before you can
+contribute code.
+
@node Acknowledgements
@chapter Acknowledgements
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/embark 810544f: Add section on contributions to README and manual,
ELPA Syncer <=