aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2022-03-07 20:12:28 +0100
committerMiguel Ángel Moreno <mail@migalmoreno.com>2022-03-07 20:12:28 +0100
commitd668c388863d266b18d6e68b86d2ff03a1561369 (patch)
tree4136807dd07b8eb369e652d3b4e4491ff175d6de
parent6f59cd8b63d440d2a82809ae075a81c208c4b3d5 (diff)
README: Tweaks installation instructions
-rw-r--r--README (renamed from README.org)10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.org b/README
index 0402042..41277fd 100644
--- a/README.org
+++ b/README
@@ -1,4 +1,6 @@
-=fdroid.el= is an Emacs interface to [[https://github.com/mvdan/fdroidcl][fdroidcl]]. Its purpose is to aid the management of F-Droid repository packages to be installed in an Android device from the comfort of Emacs.
+# -*- mode: org; -*-
+#+title: fdroid.el
+=fdroid.el= is an Emacs interface to [[https://f-droid.org/][F-Droid]]. Its purpose is to aid the management of F-Droid repository packages to be installed in an Android device from the comfort of Emacs.
To install it, simply put the =fdroid.el= file in your =load-path=, or optionally manually download the source and point to it.
@@ -6,6 +8,12 @@ To install it, simply put the =fdroid.el= file in your =load-path=, or optionall
(add-to-list 'load-path "path/to/source/fdroid.el")
#+end_src
+Alternatively, you can use the [[https://guix.gnu.org/][GNU Guix]] package manager to install the current Git checkout for the package via the provided file =emacs-fdroid.scm=. Simply run the following command in the project's root.
+
+#+begin_src sh
+guix package --install-from-file=./emacs-fdroid.scm
+#+end_src
+
This package makes use of the [[https://github.com/oantolin/embark][Embark]] and [[https://github.com/minad/consult][consult]] packages to provide a more coherent interface to the interactive commands, so ensure these are installed too. An example configuration might look like what follows.
#+begin_src elisp