[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/racket-mode 6863a2611f: Update README and docs for availab
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/racket-mode 6863a2611f: Update README and docs for availability from NonGNU ELPA |
Date: |
Wed, 16 Nov 2022 13:59:21 -0500 (EST) |
branch: elpa/racket-mode
commit 6863a2611fab30c2f05e7012c560eff0b9344991
Author: Greg Hendershott <git@greghendershott.com>
Commit: Greg Hendershott <git@greghendershott.com>
Update README and docs for availability from NonGNU ELPA
Don't merge this until it's actually available, and for example
https://elpa.nongnu.org/nongnu/racket-mode.html and .svg exist.
Related to #389.
---
README.org | 1 +
doc/racket-mode.org | 20 +++++++++++++-------
doc/racket-mode.texi | 24 ++++++++++++++++--------
3 files changed, 30 insertions(+), 15 deletions(-)
diff --git a/README.org b/README.org
index 23c108fac6..c2e3c2cd74 100644
--- a/README.org
+++ b/README.org
@@ -2,6 +2,7 @@
[[https://github.com/greghendershott/racket-mode/actions][https://github.com/greghendershott/racket-mode/workflows/CI/badge.svg]]
[[https://melpa.org/#/racket-mode][https://melpa.org/packages/racket-mode-badge.svg]]
+[[https://elpa.nongnu.org/nongnu/racket-mode.html][https://elpa.nongnu.org/nongnu/racket-mode.svg]]
[[https://www.racket-mode.com/][https://img.shields.io/badge/Docs-Documentation-blue.svg]]
This provides a major mode to edit [[https://www.racket-lang.org/][Racket]]
source files, as well as a
diff --git a/doc/racket-mode.org b/doc/racket-mode.org
index 74834338a9..a7914b813f 100644
--- a/doc/racket-mode.org
+++ b/doc/racket-mode.org
@@ -49,9 +49,17 @@ To fund this work, see
[[https://github.com/users/greghendershott/sponsorship][G
* Install, Update, and Uninstall
-The most common way to use Racket Mode is to install the package from MELPA.
+The most common way to use Racket Mode is to install from a package archive
like MELPA or NonGNU ELPA.
-Note that Racket Mode is only available on MELPA (_not_ "MELPA Stable").
+Some people also use a system like
[[https://github.com/radian-software/straight.el][straight.el]].
+
+Note that Racket Mode is only available on MELPA (/not/ "MELPA Stable"), and
is available as a "rolling release" from NonGNU ELPA.
+
+** Use Emacs 28.1 or newer with NonGNU ELPA
+
+Emacs 28.1 or newer comes configured to use [[https://elpa.nongnu.org][NonGNU
ELPA]], in which case you can skip ahead to [[Install]].
+
+With older versions of Emacs, you can use MELPA.
** Configure Emacs to use MELPA
@@ -69,15 +77,13 @@ Following is a quick guide that may work for you. (For
definitive instructions a
- Restart Emacs.
-- Type {{{kbd(M-x)}}} ~package-refresh-contents~ {{{kbd(RET)}}}.
-
#+BEGIN_QUOTE
-NOTE: If you get an error message about "contacting a host" or "downloading an
archive", the problem is not unique to Racket Mode. Please see
https://melpa.org/#/getting-started.
+NOTE: If you ever get an error message about "contacting a host" or
"downloading an archive", the problem is not unique to Racket Mode. Please see
https://melpa.org/#/getting-started.
#+END_QUOTE
** Install
-When Emacs is configured to use MELPA:
+When Emacs is configured to use NonGNU ELPA or MELPA:
1. Type {{{kbd(M-x)}}} ~package-initialize~ {{{kbd(RET)}}}.
@@ -103,7 +109,7 @@ A more-targeted approach is instead to install these
specific packages and their
raco pkg install --auto data-lib errortrace-lib macro-debugger-text-lib
rackunit-lib racket-index scribble-lib drracket-tool-text-lib
#+END_SRC
-If you /not/ want to use ~racket-xp-mode~, then you can omit
~drracket-tool-text-lib~.
+If you do /not/ want to use ~racket-xp-mode~, then you can omit
~drracket-tool-text-lib~.
On a headless server, you might want to omit ~gui-lib~. Unfortunately,
~racket-doc~ depends on ~gui-lib~. On the one hand, if you uninstall
~racket-doc~ and ~gui-lib~, you will no longer be able to access documentation
when using a Racket Mode back end running there. On the other hand, if you
leave ~gui-lib~ installed, you should be careful to run the Racket Mode back
end using ~xvfb-run racket~.
diff --git a/doc/racket-mode.texi b/doc/racket-mode.texi
index 8bca07e30a..b789f387b3 100644
--- a/doc/racket-mode.texi
+++ b/doc/racket-mode.texi
@@ -52,6 +52,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
Install, Update, and Uninstall
+* Use Emacs 28.1 or newer with NonGNU ELPA: Use Emacs 281 or newer with NonGNU
ELPA.
* Configure Emacs to use MELPA::
* Install::
* Minimal Racket::
@@ -330,10 +331,13 @@ To fund this work, see
@uref{https://github.com/users/greghendershott/sponsorshi
@node Install Update and Uninstall
@chapter Install, Update, and Uninstall
-The most common way to use Racket Mode is to install the package from MELPA.
+The most common way to use Racket Mode is to install from a package archive
like MELPA or NonGNU ELPA.
-Note that Racket Mode is only available on MELPA (@math{_not}_ ``MELPA
Stable'').
+Some people also use a system like
@uref{https://github.com/radian-software/straight.el,straight.el}.
+
+Note that Racket Mode is only available on MELPA (@emph{not} ``MELPA
Stable''), and is available as a ``rolling release'' from NonGNU ELPA.
@menu
+* Use Emacs 28.1 or newer with NonGNU ELPA: Use Emacs 281 or newer with NonGNU
ELPA.
* Configure Emacs to use MELPA::
* Install::
* Minimal Racket::
@@ -341,6 +345,13 @@ Note that Racket Mode is only available on MELPA
(@math{_not}_ ``MELPA Stable'')
* Update::
@end menu
+@node Use Emacs 281 or newer with NonGNU ELPA
+@section Use Emacs 28.1 or newer with NonGNU ELPA
+
+Emacs 28.1 or newer comes configured to use
@uref{https://elpa.nongnu.org,NonGNU ELPA}, in which case you can skip ahead to
@ref{Install,Install}.
+
+With older versions of Emacs, you can use MELPA.
+
@node Configure Emacs to use MELPA
@section Configure Emacs to use MELPA
@@ -362,19 +373,16 @@ Add the following to your @verb{,~/.emacs,} or
@verb{,~/.emacs.d/init.el,}:
@itemize
@item
Restart Emacs.
-
-@item
-Type @kbd{M-x} @code{package-refresh-contents} @kbd{RET} .
@end itemize
@quotation
-NOTE: If you get an error message about ``contacting a host'' or ``downloading
an archive'', the problem is not unique to Racket Mode. Please see
@uref{https://melpa.org/#/getting-started}.
+NOTE: If you ever get an error message about ``contacting a host'' or
``downloading an archive'', the problem is not unique to Racket Mode. Please
see @uref{https://melpa.org/#/getting-started}.
@end quotation
@node Install
@section Install
-When Emacs is configured to use MELPA:
+When Emacs is configured to use NonGNU ELPA or MELPA:
@enumerate
@item
@@ -406,7 +414,7 @@ A more-targeted approach is instead to install these
specific packages and their
raco pkg install --auto data-lib errortrace-lib macro-debugger-text-lib
rackunit-lib racket-index scribble-lib drracket-tool-text-lib
@end example
-If you @emph{not} want to use @code{racket-xp-mode}, then you can omit
@code{drracket-tool-text-lib}.
+If you do @emph{not} want to use @code{racket-xp-mode}, then you can omit
@code{drracket-tool-text-lib}.
On a headless server, you might want to omit @code{gui-lib}. Unfortunately,
@code{racket-doc} depends on @code{gui-lib}. On the one hand, if you uninstall
@code{racket-doc} and @code{gui-lib}, you will no longer be able to access
documentation when using a Racket Mode back end running there. On the other
hand, if you leave @code{gui-lib} installed, you should be careful to run the
Racket Mode back end using @code{xvfb-run racket}.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [nongnu] elpa/racket-mode 6863a2611f: Update README and docs for availability from NonGNU ELPA,
ELPA Syncer <=