diff options
| author | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-04-27 15:14:28 +0200 |
|---|---|---|
| committer | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-04-27 15:14:28 +0200 |
| commit | 87feac522a7d310b18c22bf07d48a0850a499096 (patch) | |
| tree | 3a3d5a2caac615e463705ee24f589224bfd2dba0 | |
| parent | 6828874cc32c31690d4f0d94e95065c7b7d6265a (diff) | |
doc: Add Markdown version of README
| -rw-r--r-- | README | 2 | ||||
| -rw-r--r-- | README.md | 33 |
2 files changed, 34 insertions, 1 deletions
@@ -34,4 +34,4 @@ Above, we set a global binding for the =fdroid-map=. From here onward we can use - =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/~mmoreno/fdroid.el][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~mmoreno/fdroid.el][bug-tracker]]. +You can send feedback, patches, or bug reports to [[mailto:public@mianmoreno.com][public@mianmoreno.com]]. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4adeba0 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ + + +# fdroid.el + +`fdroid.el` is an Emacs interface to [F-Droid](https://f-droid.org/). Its purpose is to aid in the management of F-Droid packages for an Android device or an emulator inside the comfort of Emacs. + +To install it manually, simply point to the `fdroid.el` Git checkout in your `load-path`. + + (add-to-list 'load-path "path/to/fdroid.el") + +If you'd like to contribute to the project, the easiest way is for you to install the [GNU Guix](https://guix.gnu.org/) package manager and start developing on the local checkout by invoking the following commands: + + cd /path/to/fdroid.el + guix shell --pure + +Since this package leverages the [fdroidcl](https://github.com/mvdan/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 `M-x fdroid-update` command. + +An example configuration might look like this: + + (define-key global-map (kbd "C-c C--") 'fdroid-map) ; Set your preferred binding for the fdroid-map + (with-eval-after-load 'fdroid + (setopt fdroid-log-events t) ; Whether messages should be logged after an operation + (setopt fdroid-sans-device t)) ; Perform `fdroid-*' operations without a connected device + +Above, we set a global binding for the `fdroid-map`. From here onward we can use the `fdroid-list-packages` 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 [Embark](https://github.com/oantolin/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. + +You can send feedback, patches, or bug reports to [public@mianmoreno.com](mailto:public@mianmoreno.com). + |