diff options
author | Miguel Ángel Moreno <mail@migalmoreno.com> | 2022-06-14 11:07:54 +0200 |
---|---|---|
committer | Miguel Ángel Moreno <mail@migalmoreno.com> | 2022-06-14 11:07:54 +0200 |
commit | 070e68fe7086e16a2f53d643625b658f862cd280 (patch) | |
tree | a50b4ca11a85e747983c2a10b95c8b6e1026700c | |
parent | 8b8de25011a3afa3ad544e4c18afd4dda3958267 (diff) |
chore: Updates documentation
-rw-r--r-- | README | 17 |
1 files changed, 10 insertions, 7 deletions
@@ -2,29 +2,32 @@ #+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. +To install it manually, simply point to the =fdroid.el= Git checkout in your =load-path=. #+begin_src elisp -(add-to-list 'load-path "path/to/source/fdroid.el") +(add-to-list 'load-path "path/to/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. +If you'd like to contribute to the project, the easiest way is for you to install the [[https://guix.gnu.org/][GNU Guix]] package manager and start developing on it by invoking the following commands: #+begin_src sh -guix package --install-from-file=./emacs-fdroid.scm +cd /path/to/fdroid.el +guix shell --pure #+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. +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: #+begin_src elisp (fdroid-default-keybindings) (with-eval-after-load 'fdroid (custom-set-variables '(fdroid-log-events t) ; Whether messages should be logged after an operation - '(fdroid-program (executable-find "fdroidcl")))) ; Path to `fdroidcl' + '(fdroid-sans-device t))) ; Perform `fdroid-*' operations without a connected device #+end_src -In the above configuration, we set the default keybindings for the =fdroid-map= and 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. We can then invoke the following Embark actions on the targets: - ~i~ :: install the current package. - ~u~ :: uninstall the current package. |