branch: elpa/hyperdrive
commit 1485089192c1113a81717b0b07ddfff36315de22
Author: Joseph Turner <[email protected]>
Commit: Joseph Turner <[email protected]>
Docs: Document hyperdrive-install
---
doc/hyperdrive.org | 19 ++++++++++++++-----
doc/hyperdrive.texi | 28 ++++++++++++++++++++--------
2 files changed, 34 insertions(+), 13 deletions(-)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 8817fdcb93..fd48729a63 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -43,11 +43,6 @@ modify this GNU manual."
~hyperdrive.el~ requires [[https://www.gnu.org/software/emacs/][GNU Emacs]]
version 28.1 or later.
-** Install hyper-gateway-ushin
-
-~hyperdrive.el~ relies on
[[https://git.sr.ht/~ushin/hyper-gateway-ushin/][hyper-gateway-ushin]] for
talking to the
-hypercore network
([[https://git.sr.ht/~ushin/hyper-gateway-ushin#installation][installation
instructions]]).
-
** Install hyperdrive.el
~hyperdrive.el~ can be installed from
[[https://elpa.nongnu.org/nongnu/hyperdrive.html][NonGNU ELPA]] with ~M-x
@@ -59,6 +54,16 @@ version of ~hyperdrive.el~ by running ~M-x
package-refresh-contents~ then
is not available as a command, display the list of packages with ~M-x
list-packages~, select ~hyperdrive~, and click the ~Install~ button.
+** Install hyper-gateway-ushin
+
+~hyperdrive.el~ relies on
[[https://git.sr.ht/~ushin/hyper-gateway-ushin/][hyper-gateway-ushin]] for
talking to the
+hypercore network.
+
+After installing ~hyperdrive.el~ (see [[*Install hyperdrive.el][Install
hyperdrive.el]]), run ~M-x
+hyperdrive-install~ to download and install ~hyper-gateway-ushin~.
+
+Alternatively, follow the
[[https://git.sr.ht/~ushin/hyper-gateway-ushin#installation][manual
installation instructions]].
+
* Example configuration
After following the [[*Installation][installation instructions]], you can add
this
@@ -91,6 +96,10 @@ When you upload a file, beware:
On the network it still may be there.
#+end_verse
+** Install hyper-gateway-ushin
+
+Please be sure to [[*Install hyper-gateway-ushin][install
hyper-gateway-ushin]].
+
** Menu bar support
#+findex: menu-bar-mode
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index e47ff36557..f7260fdfe7 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -69,11 +69,12 @@ This manual is for @code{hyperdrive.el} version 0.4-pre.
Installation
* Install Emacs::
-* Install hyper-gateway-ushin::
* Install hyperdrive.el: Install hyperdriveel.
+* Install hyper-gateway-ushin::
Usage
+* Install hyper-gateway-ushin: Install hyper-gateway-ushin (1).
* Menu bar support::
* Hyperdrive menu command::
* Start/stop the gateway::
@@ -198,8 +199,8 @@ modify this GNU manual.''
@menu
* Install Emacs::
-* Install hyper-gateway-ushin::
* Install hyperdrive.el: Install hyperdriveel.
+* Install hyper-gateway-ushin::
@end menu
@node Install Emacs
@@ -207,12 +208,6 @@ modify this GNU manual.''
@code{hyperdrive.el} requires @uref{https://www.gnu.org/software/emacs/, GNU
Emacs} version 28.1 or later.
-@node Install hyper-gateway-ushin
-@section Install hyper-gateway-ushin
-
-@code{hyperdrive.el} relies on
@uref{https://git.sr.ht/~ushin/hyper-gateway-ushin/, hyper-gateway-ushin} for
talking to the
-hypercore network
(@uref{https://git.sr.ht/~ushin/hyper-gateway-ushin#installation, installation
instructions}).
-
@node Install hyperdriveel
@section Install hyperdrive.el
@@ -225,6 +220,17 @@ version of @code{hyperdrive.el} by running @code{M-x
package-refresh-contents} t
is not available as a command, display the list of packages with @code{M-x
list-packages}, select @code{hyperdrive}, and click the @code{Install} button.
+@node Install hyper-gateway-ushin
+@section Install hyper-gateway-ushin
+
+@code{hyperdrive.el} relies on
@uref{https://git.sr.ht/~ushin/hyper-gateway-ushin/, hyper-gateway-ushin} for
talking to the
+hypercore network.
+
+After installing @code{hyperdrive.el} (see @ref{Install hyperdriveel, ,
Install hyperdrive.el}), run @code{M-x
+hyperdrive-install} to download and install @code{hyper-gateway-ushin}.
+
+Alternatively, follow the
@uref{https://git.sr.ht/~ushin/hyper-gateway-ushin#installation, manual
installation instructions}.
+
@node Example configuration
@chapter Example configuration
@@ -260,6 +266,7 @@ On the network it still may be there.
@end display
@menu
+* Install hyper-gateway-ushin: Install hyper-gateway-ushin (1).
* Menu bar support::
* Hyperdrive menu command::
* Start/stop the gateway::
@@ -281,6 +288,11 @@ On the network it still may be there.
* Miscellaneous features::
@end menu
+@node Install hyper-gateway-ushin (1)
+@section Install hyper-gateway-ushin
+
+Please be sure to @ref{Install hyper-gateway-ushin (1), , install
hyper-gateway-ushin}.
+
@node Menu bar support
@section Menu bar support
