diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 39 |
1 files changed, 24 insertions, 15 deletions
@@ -1,8 +1,12 @@ #+OPTIONS: toc:nil -* mastodon.el fork +* mastodon.el updated -This is a fork of of the great but seemingly dormant https://github.com/jdenen/mastodon.el. +This is an updated version of the great but seemingly dormant mastodon client for emacs. + +This is now the version available via MELPA. + +[The original readme is below.] It adds the following features: @@ -13,7 +17,7 @@ It adds the following features: | | display toots/follows/followers counts | | | links/tags/mentions in profile bios are active links | | | show a lock icon for locked accounts | -| =G= | view follow suggestions | +| =G= | view follow suggestions | | =R=, =a=, =r= | view/accept/reject follow requests | | =V= | view your favorited toots | | =i= | toggle pinning of toots | @@ -21,7 +25,7 @@ It adds the following features: | =O= | jump to own profile | | Notifications: | | | | follow requests now also appear in notifications | -| =a=, =j= | accept/reject follow request | +| =a=, =j= | accept/reject follow request | | | notifications for when a user posts (=mastodon-tl--enable-notify-user-posts=) | | Timelines: | | | =C= | copy url of toot at point | @@ -29,7 +33,8 @@ It adds the following features: | =D= | delete and redraft toot at point, preserving reply/CW/visibility | | =W=, =M=, =B= | (un)follow, (un)mute, (un)block author of toot at point | | =k=, =K= | toggle bookmark of toot at point, view bookmarked toots | -| =I=, =c=, =d= | view, create, and delete filters | +| =I=, =c=, =d= | view, create, and delete filters | +| | display image captions | | | display polls and vote on them | | | images are links to the full image, can be zoomed/rotated/saved (see image keymap) | | | images scale properly | @@ -53,17 +58,13 @@ It adds the following features: It also makes some small cosmetic changes to make timelines easier to read, and makes some functions asynchronous, based on https://github.com/ieure/mastodon.el. -This updated version is not on MELPA, to use it you need to clone and require it as per the installation instructions below. - -The minimum Emacs version is now 26.1. But if you are running an older version it shouldn't be very hard to get it working. - -I did this for my own use and to learn more Elisp. Feel free to improve it. +The minimum Emacs version is now 27.1. But if you are running an older version it shouldn't be very hard to get it working. ** live-updating timelines: =mastodon-async-mode= (code taken from https://github.com/alexjgriffith/mastodon-future.el.) -Works for federated, local, and home timelines and for notifications. It's pretty necro, sometimes it goes off the rails, so use at your own risk. Not a super high priority for me, but some people dig it. +Works for federated, local, and home timelines and for notifications. It's a little touchy, one thing to avoid is trying to load a timeline more than once at a time. It can go off the rails a bit, but it's still pretty cool. To enable, it, add =(require 'mastodon-async)= to your =init.el=. Then you can view a timeline with one of the commands that begin with =mastodon-async--stream-=. @@ -84,9 +85,15 @@ You could easily modify the simple function to use your emacs translator of choi (message "No toot to translate?")))) #+end_src -** NB: dependency +** NB: dependencies -This version depends on the library =request= (for uploading attachments). If you installed =mastodon.el= from MELPA, it should be fine, else you can install it yourself from MELPA or https://github.com/tkf/emacs-request. +This version depends on the library =request= (for uploading attachments). You can install it from MELPA, or https://github.com/tkf/emacs-request. It also depends on =seq=. + +Optional dependencies: +- =company= for autocompletion of mentions when composing a toot +- =emojify= for inserting and viewing emojis +- =mpv= and =mpv.el= for viewing videos and gifs +- =lingva.el= for translating toots ** NB: bugs @@ -96,9 +103,11 @@ This repo also incorporates fixes for two bugs that were never merged into the u ** contributing -Contributions are welcome. Feel free to open an issue or get in touch with me on mastodon: +Contributions are welcome. -[[https://todon.nl/@mousebot][@mousebot@todon.nl]] +1. Create an here on codeberg detailing the feature you'd like to add. +2. Fork the repository and create a branch off of =develop=. +3. Create a pull request referencing the issue created in step 1. * Original README |