README

fdroid.el

fdroid.el is an Emacs interface to F-Droid. Its purpose is to aid in the management of F-Droid packages for an Android device or an emulator inside the comfort of Emacs.

Installation

To install the package manually, simply point to the checkout in your load-path.

(add-to-list 'load-path "path/to/fdroid.el")

Alternatively, if you want to get a development environment set up quickly, it’s suggested you install a package manager such as GNU Guix or Nix and start developing on the local package checkout with these commands:

For GNU Guix:

guix shell --pure

For Nix:

nix develop

Since this package leverages the fdroidcl F-Droid desktop client for most of its functionality, it’s necessary for you to have it installed too. If it’s your first time using fdroidcl, ensure to download the F-Droid repository index first via the M-x fdroid-update command.

Usage

An example fdroid.el configuration might look like this:

(define-key global-map (kbd "C-c f") 'fdroid-map)
(with-eval-after-load 'fdroid
  (setq fdroid-log-events t)
  (setq fdroid-sans-device t))

Above, we set a global binding for the fdroid-map and modify a couple of settings which control the verbosity of fdroidcl commands and whether we can run commands without a connected device.

To show all packages available in the current F-Droid repositories you can run the fdroid-list-packages command. You can then invoke the interactive commands set below or, if you have the Embark package installed, the corresponding Embark actions on the mini-buffer targets:

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.