aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2022-07-26 13:48:55 +0200
committerMiguel Ángel Moreno <mail@migalmoreno.com>2022-07-26 15:30:50 +0200
commit962032cd4a6cfd3a27543caf15d66d8bd44da13f (patch)
treed66fef8eb4eca453a43029f03e3c3491eef2959e
parentd1aaf9065d64878f35bba32461c28a99a07f069a (diff)
chore: Updates README
-rw-r--r--README19
1 files changed, 11 insertions, 8 deletions
diff --git a/README b/README
index 64911e7..6061fa1 100644
--- a/README
+++ b/README
@@ -1,5 +1,6 @@
-# -*- mode: org; -*-
-#+title: fdroid.el
+# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
+#+OPTIONS: toc:nil
+* 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 manually, simply point to the =fdroid.el= Git checkout in your =load-path=.
@@ -17,7 +18,7 @@ guix shell --pure
Since this package leverages the [[https://github.com/mvdan/fdroidcl][fdroidcl]] F-Droid desktop client for most of its functionality, it's necessary for you to have it installed. If it's your first time using =fdroidcl=, ensure to download the F-Droid repository index via the =fdroid-update= command.
-Additionally, it uses the [[https://github.com/oantolin/embark][Embark]] and [[https://github.com/minad/consult][consult]] packages to provide a more natural interface to the interactive commands. An example configuration might look like this:
+An example configuration might look like this:
#+begin_src elisp
(fdroid-default-keybindings)
@@ -27,9 +28,11 @@ Additionally, it uses the [[https://github.com/oantolin/embark][Embark]] and [[h
'(fdroid-sans-device t))) ; Perform `fdroid-*' operations without a connected device
#+end_src
-Above, we set the default keybindings for the =fdroid-map=, meaning from here on we can use the =fdroid-list-packages= (~C-c C-- l~) command to show all packages available for the current F-Droid repository. We can then invoke the following Embark actions on the targets:
+Above, we set the default keybindings for the =fdroid-map=, meaning from here on we can use the =fdroid-list-packages= (~C-c C-- l~) command to show all packages available for the current F-Droid repository. You can then invoke the interactive commands set below or, if you have the [[https://github.com/oantolin/embark][Embark]] package installed, the following Embark actions on the mini-buffer targets:
-- ~i~ :: install the current package.
-- ~u~ :: uninstall the current package.
-- ~d~ :: download the current package.
-- ~s~ :: show more information about the current package.
+- =fdroid-install= (~i~) :: install the current package.
+- =fdroid-uninstall= (~u~) :: uninstall the current package.
+- =fdroid-download= (~d~) :: download the current package.
+- =fdroid-show= (~s~) :: show more information about the current package.
+
+You can use the project's [[https://lists.sr.ht/~conses/fdroid.el][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~conses/fdroid.el][bug-tracker]].