From cd2931dfd43d6e709779fb762cc951a540154a72 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Thu, 24 Nov 2022 13:34:08 +0100 Subject: readme read compatability --- README.org | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'README.org') diff --git a/README.org b/README.org index 92a2049..06f2970 100644 --- a/README.org +++ b/README.org @@ -6,7 +6,7 @@ * README -=mastodon.el= is an Emacs client for the Mastodon and Pleroma social networks. For info see https://joinmastodon.org/. +=mastodon.el= is an Emacs client for the AcitivityPub social networks that implement the Mastodon API. For info see https://joinmastodon.org/. ** Installation @@ -310,6 +310,12 @@ Optional dependencies: - =mpv= and =mpv.el= for viewing videos and gifs - =lingva.el= for translating toots +** Network compatibility. + +=mastodon.el= should work with ActivityPub servers that implement the Mastodon API. + +Apart from Mastodon itself, it is currently known to work with Pleroma and Gotosocial. If you attempt to use =mastodon.el= with another server that implements the Mastodon API and run into problems, feel free to open an issue. + ** Contributing PRs, issues, feature requests, and general feedback are very welcome! -- cgit v1.2.3 From 92f59ff56bf9264b3b1981d3d32cf9172a490ef0 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Sat, 26 Nov 2022 10:09:39 +0100 Subject: readme fill paras --- README.org | 60 +++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 19 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index 06f2970..61d8246 100644 --- a/README.org +++ b/README.org @@ -6,7 +6,8 @@ * README -=mastodon.el= is an Emacs client for the AcitivityPub social networks that implement the Mastodon API. For info see https://joinmastodon.org/. +=mastodon.el= is an Emacs client for the AcitivityPub social networks that +implement the Mastodon API. For info see https://joinmastodon.org/. ** Installation @@ -25,7 +26,8 @@ Or, with =use-package=: :ensure t) #+END_SRC -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. +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. *** MELPA @@ -100,10 +102,10 @@ restart Emacs and follow the steps again. =M-x mastodon= -Opens a =*mastodon-home*= buffer in the major mode and displays toots. If your credentials are not yet saved, you -will be prompted for email and password. The app registration process will -take place if your =mastodon-token-file= does not contain =:client_id= and -=:client_secret=. +Opens a =*mastodon-home*= buffer in the major mode and displays toots. If your +credentials are not yet saved, you will be prompted for email and password. +The app registration process will take place if your =mastodon-token-file= does +not contain =:client_id= and =:client_secret=. **** Keybindings @@ -222,12 +224,16 @@ You can download and use your instance's custom emoji *** Other commands and account settings: -- =mastodon-url-lookup=: Attempt to load URL in =mastodon.el=. URL may be the one at point or provided in the minibuffer. Should also work if =mastodon.el= is not yet loaded. +- =mastodon-url-lookup=: Attempt to load URL in =mastodon.el=. URL may be the one + at point or provided in the minibuffer. Should also work if =mastodon.el= is + not yet loaded. -- =mastodon-tl--view-instance-description=: View information about the instance that the author of the toot at point is on. +- =mastodon-tl--view-instance-description=: View information about the instance + that the author of the toot at point is on. - =mastodon-tl--view-own-instance=: View information about your own instance. -- =mastodon-search--trending-tags=: View a list of trending hashtags on your instance. +- =mastodon-search--trending-tags=: View a list of trending hashtags on your + instance. - =mastodon-tl--follow-tag=: Follow a tag (works like following a user) @@ -235,14 +241,21 @@ You can download and use your instance's custom emoji - =mastodon-tl--list-followed-tags=: View a list of tags you're following. -- =mastodon-profile--update-display-name=: Update the display name for your account. +- =mastodon-profile--update-display-name=: Update the display name for your + account. - =mastodon-profile--update-user-profile-note=: Update your bio note. - =mastodon-profile--update-meta-fields=: Update your metadata fields. -- =mastodon-profile--set-default-toot-visibility=: Set the default visibility for your toots. -- =mastodon-profile--account-locked-toggle=: Toggle the locked status of your account. Locked accounts have to manually approve follow requests. -- =mastodon-profile--account-discoverable-toggle=: Toggle the discoverable status of your account. Non-discoverable accounts are not listed in the profile directory. -- =mastodon-profile--account-bot-toggle=: Toggle whether your account is flagged as a bot. -- =mastodon-profile--account-sensitive-toggle=: Toggle whether your posts are marked as sensitive (nsfw) by default. +- =mastodon-profile--set-default-toot-visibility=: Set the default visibility + for your toots. +- =mastodon-profile--account-locked-toggle=: Toggle the locked status of your + account. Locked accounts have to manually approve follow requests. +- =mastodon-profile--account-discoverable-toggle=: Toggle the discoverable + status of your account. Non-discoverable accounts are not listed in the + profile directory. +- =mastodon-profile--account-bot-toggle=: Toggle whether your account is flagged + as a bot. +- =mastodon-profile--account-sensitive-toggle=: Toggle whether your posts are + marked as sensitive (nsfw) by default. *** Customization @@ -314,7 +327,9 @@ Optional dependencies: =mastodon.el= should work with ActivityPub servers that implement the Mastodon API. -Apart from Mastodon itself, it is currently known to work with Pleroma and Gotosocial. If you attempt to use =mastodon.el= with another server that implements the Mastodon API and run into problems, feel free to open an issue. +Apart from Mastodon itself, it is currently known to work with Pleroma and +Gotosocial. If you attempt to use =mastodon.el= with another server that +implements the Mastodon API and run into problems, feel free to open an issue. ** Contributing @@ -324,8 +339,12 @@ PRs, issues, feature requests, and general feedback are very welcome! 1. =mastodon.el= has bugs, as well as lots of room for improvement. 2. I receive very little feedback, so if I don't run into the bug it often doesn't get fixed. -3. If you run into something that seems broken, first try running =mastodon.el= in emacs with no init file (i.e. =emacs -q= (instructions and code for doing this are [[https://codeberg.org/martianh/mastodon.el/issues/300][here]]) to see if it also happens independently of your own config (it probably does). -4. Enable debug on error (=toggle-debug-on-error=), make the bug happen again, and copy the backtrace that appears. +3. If you run into something that seems broken, first try running =mastodon.el= + in emacs with no init file (i.e. =emacs -q= (instructions and code for doing + this are [[https://codeberg.org/martianh/mastodon.el/issues/300][here]]) to see if it also happens independently of your own config + (it probably does). +4. Enable debug on error (=toggle-debug-on-error=), make the bug happen again, + and copy the backtrace that appears. 5. Open an issue here and explain what is going on. *** Fixes and features @@ -337,7 +356,10 @@ PRs, issues, feature requests, and general feedback are very welcome! ** Supporting mastodon.el -If you'd like to support continued development of =mastodon.el=, I accept donations via paypal at martianhiatus [ at ] riseup [ dot ] net. If you would prefer a different payment method, write to me at that address and I can provide IBAN or other details. +If you'd like to support continued development of =mastodon.el=, I accept +donations via paypal at martianhiatus [ at ] riseup [ dot ] net. If you would +prefer a different payment method, write to me at that address and I can +provide IBAN or other details. I don't have a tech worker's income, so even a small tip would help out. -- cgit v1.2.3 From 6c5d9b39abc9ec5b1d8d5fd93bf13b079c523e18 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Fri, 13 Jan 2023 09:46:17 +0100 Subject: readme --- README.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.org') diff --git a/README.org b/README.org index 85ff179..c9245d7 100644 --- a/README.org +++ b/README.org @@ -350,7 +350,7 @@ PRs, issues, feature requests, and general feedback are very welcome! (it probably does). 4. Enable debug on error (=toggle-debug-on-error=), make the bug happen again, and copy the backtrace that appears. -5. Open an issue here and explain what is going on. +5. Open an issue here and explain what is going on. Provide your emacs version and what kind of server your account is on. *** Fixes and features -- cgit v1.2.3 From e232e078bd1e26cb770519d7ce9c00c547fded7e Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Fri, 13 Jan 2023 12:17:59 +0100 Subject: readme: coding style pointers --- README.org | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.org') diff --git a/README.org b/README.org index c9245d7..2cbc066 100644 --- a/README.org +++ b/README.org @@ -359,6 +359,13 @@ PRs, issues, feature requests, and general feedback are very welcome! 3. Run the tests and ensure that your code doesn't break any of them. 4. Create a pull request referencing the issue created in step 1. +*** coding style + +- This library uses an unconvential double dash (=--=) between file namespaces and function names, which contradicts normal Elisp style. This needs to be respected until the whole library is changed. +- Use =aggressive-indent-mode= or similar to keep your code indented. +- Single spaces end sentences in docstrings. +- There's no need for a blank line after the first docstring line (one is added automatically when documentation is displayed). + ** Supporting mastodon.el If you'd like to support continued development of =mastodon.el=, I accept -- cgit v1.2.3 From 7d4d8bc059c9253b66fb694593e7c9bc8bafbc41 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Fri, 13 Jan 2023 12:51:11 +0100 Subject: readme: paypalme --- README.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.org') diff --git a/README.org b/README.org index 2cbc066..b180051 100644 --- a/README.org +++ b/README.org @@ -369,7 +369,7 @@ PRs, issues, feature requests, and general feedback are very welcome! ** Supporting mastodon.el If you'd like to support continued development of =mastodon.el=, I accept -donations via paypal at martianhiatus [ at ] riseup [ dot ] net. If you would +donations via paypal: https://paypal.me/martianh. If you would prefer a different payment method, write to me at that address and I can provide IBAN or other details. -- cgit v1.2.3 From 01e4bc440f9d89e2ac5ef06cfd160ddea743b3f1 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Tue, 28 Feb 2023 22:38:56 +0100 Subject: update readme bindings --- README.org | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.org') diff --git a/README.org b/README.org index f13a538..f460b0e 100644 --- a/README.org +++ b/README.org @@ -167,12 +167,13 @@ not contain =:client_id= and =:client_secret=. |----------------+---------------------------------------------------------------------------| | | *Notifications view* | | =a=, =j= | accept/reject follow request | -| =c= | clear notification at point | +| =C-k= | clear notification at point | | | see =mastodon-notifications--get-*= functions for filtered views | |----------------+---------------------------------------------------------------------------| | | *Quitting* | | =q= | Quit mastodon buffer, leave window open | | =Q= | Quit mastodon buffer and kill window | +| =C-M-q= | Quit and kill all mastodon buffers | |----------------+---------------------------------------------------------------------------| **** Toot byline legend -- cgit v1.2.3 From 3834d8f29bd1d293d41febe965daaf39887b088a Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Wed, 29 Mar 2023 17:03:10 +0200 Subject: readme: trending statuses --- README.org | 1 + 1 file changed, 1 insertion(+) (limited to 'README.org') diff --git a/README.org b/README.org index 66ec6d7..ca443d4 100644 --- a/README.org +++ b/README.org @@ -260,6 +260,7 @@ work without first loading =mastodon.el=: - =mastodon-tl--view-own-instance=: View information about your own instance. - =mastodon-search--trending-tags=: View a list of trending hashtags on your instance. +- =mastodon-search--trending-statuses=: View a list of trending statuses on your instance. - =mastodon-tl--add-toot-account-at-point-to-list=: Add the account of the toot at point to a list. -- cgit v1.2.3