diff options
| -rw-r--r-- | README.org | 38 | ||||
| -rw-r--r-- | mastodon.info | 134 | ||||
| -rw-r--r-- | mastodon.texi | 64 |
3 files changed, 145 insertions, 91 deletions
@@ -13,23 +13,15 @@ implement the Mastodon API. For info see [[https://joinmastodon.org/][joinmastod ** Installation -Clone this repository and add the lisp directory to your load path. -Then, require it and go. +You can install =mastodon.el= from ELPA, MELPA, or directly from this repo. -#+BEGIN_SRC emacs-lisp - (add-to-list 'load-path "/path/to/mastodon.el/lisp") - (require 'mastodon) -#+END_SRC +*** ELPA -Or, with =use-package=: +You should be able to directly install with: -#+BEGIN_SRC emacs-lisp - (use-package mastodon - :ensure t) -#+END_SRC +=M-x package-refresh-contents RET= -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. +=M-x package-install RET mastodon RET= *** MELPA @@ -47,6 +39,26 @@ Update and install: =M-x package-install RET mastodon RET= +*** Repo + +Clone this repository and add the lisp directory to your load path. +Then, require it and go. + +#+BEGIN_SRC emacs-lisp + (add-to-list 'load-path "/path/to/mastodon.el/lisp") + (require 'mastodon) +#+END_SRC + +Or, with =use-package=: + +#+BEGIN_SRC emacs-lisp + (use-package mastodon + :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. + *** Emoji =mastodon-mode= will enable [[https://github.com/iqbalansari/emacs-emojify][Emojify]] if it is loaded in your Emacs environment, so diff --git a/mastodon.info b/mastodon.info index caae4d9..4b0c512 100644 --- a/mastodon.info +++ b/mastodon.info @@ -27,7 +27,9 @@ README Installation +* ELPA:: * MELPA:: +* repo:: * Emoji:: * Discover:: @@ -42,7 +44,7 @@ Usage * Alternative timeline layout:: * Live-updating timelines mastodon-async-mode:: * Translating toots:: -* bookmarks and ‘mastodon.el’: bookmarks and mastodonel. +* Bookmarks and ‘mastodon.el’: Bookmarks and mastodonel. Contributing @@ -77,30 +79,33 @@ File: mastodon.info, Node: Installation, Next: Usage, Up: README 1.1 Installation ================ -Clone this repository and add the lisp directory to your load path. -Then, require it and go. - - (add-to-list 'load-path "/path/to/mastodon.el/lisp") - (require 'mastodon) - - Or, with ‘use-package’: - - (use-package mastodon - :ensure t) - - 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. +You can install ‘mastodon.el’ from ELPA, MELPA, or directly from this +repo. * Menu: +* ELPA:: * MELPA:: +* repo:: * Emoji:: * Discover:: -File: mastodon.info, Node: MELPA, Next: Emoji, Up: Installation +File: mastodon.info, Node: ELPA, Next: MELPA, Up: Installation + +1.1.1 ELPA +---------- + +You should be able to directly install with: + + ‘M-x package-refresh-contents RET’ + + ‘M-x package-install RET mastodon RET’ + + +File: mastodon.info, Node: MELPA, Next: repo, Prev: ELPA, Up: Installation -1.1.1 MELPA +1.1.2 MELPA ----------- Add ‘MELPA’ to your archives: @@ -116,9 +121,29 @@ Add ‘MELPA’ to your archives: ‘M-x package-install RET mastodon RET’ -File: mastodon.info, Node: Emoji, Next: Discover, Prev: MELPA, Up: Installation +File: mastodon.info, Node: repo, Next: Emoji, Prev: MELPA, Up: Installation + +1.1.3 repo +---------- + +Clone this repository and add the lisp directory to your load path. +Then, require it and go. + + (add-to-list 'load-path "/path/to/mastodon.el/lisp") + (require 'mastodon) + + Or, with ‘use-package’: + + (use-package mastodon + :ensure t) + + 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. + + +File: mastodon.info, Node: Emoji, Next: Discover, Prev: repo, Up: Installation -1.1.2 Emoji +1.1.4 Emoji ----------- ‘mastodon-mode’ will enable Emojify @@ -129,7 +154,7 @@ Emacs environment, so there’s no need to write your own hook anymore. File: mastodon.info, Node: Discover, Prev: Emoji, Up: Installation -1.1.3 Discover +1.1.5 Discover -------------- ‘mastodon-mode’ can provide a context menu for its keybindings if @@ -166,7 +191,7 @@ File: mastodon.info, Node: Usage, Next: Dependencies, Prev: Installation, Up * Alternative timeline layout:: * Live-updating timelines mastodon-async-mode:: * Translating toots:: -* bookmarks and ‘mastodon.el’: bookmarks and mastodonel. +* Bookmarks and ‘mastodon.el’: Bookmarks and mastodonel. File: mastodon.info, Node: Logging in to your instance, Next: Timelines, Up: Usage @@ -491,7 +516,7 @@ Then you can view a timeline with one of the commands that begin with ‘mastodon-async--stream-’. -File: mastodon.info, Node: Translating toots, Next: bookmarks and mastodonel, Prev: Live-updating timelines mastodon-async-mode, Up: Usage +File: mastodon.info, Node: Translating toots, Next: Bookmarks and mastodonel, Prev: Live-updating timelines mastodon-async-mode, Up: Usage 1.2.9 Translating toots ----------------------- @@ -518,9 +543,9 @@ looks like: (message "No toot to translate?")))) -File: mastodon.info, Node: bookmarks and mastodonel, Prev: Translating toots, Up: Usage +File: mastodon.info, Node: Bookmarks and mastodonel, Prev: Translating toots, Up: Usage -1.2.10 bookmarks and ‘mastodon.el’ +1.2.10 Bookmarks and ‘mastodon.el’ ---------------------------------- ‘mastodon.el’ doesn’t currently implement its own bookmark record and @@ -539,9 +564,8 @@ Hard dependencies (should all install with ‘mastodon.el’): • ‘request’ (for uploading attachments), emacs-request (https://github.com/tkf/emacs-request) • ‘persist’ for storing some settings across sessions - • ‘ts’ for poll relative expiry times - Optional dependencies: + Optional dependencies (install yourself, ‘mastodon.el’ can use them): • ‘emojify’ for inserting and viewing emojis • ‘mpv’ and ‘mpv.el’ for viewing videos and gifs • ‘lingva.el’ for translating toots @@ -656,35 +680,37 @@ File: mastodon.info, Node: Contributors, Prev: Supporting mastodonel, Up: REA Tag Table: Node: Top210 -Node: README944 -Node: Installation1360 -Node: MELPA1896 -Node: Emoji2264 -Node: Discover2596 -Node: Usage3148 -Node: Logging in to your instance3591 -Node: Timelines4588 -Ref: Keybindings5063 -Ref: Toot byline legend9636 -Node: Composing toots9945 -Ref: Keybindings (1)11184 -Ref: Autocompletion of mentions and tags11702 -Ref: Draft toots12415 -Node: Other commands and account settings12886 -Node: Customization16044 -Node: Commands and variables index16831 -Node: Alternative timeline layout17151 -Node: Live-updating timelines mastodon-async-mode17556 -Node: Translating toots18408 -Node: bookmarks and mastodonel19590 -Node: Dependencies20062 -Node: Network compatibility20668 -Node: Contributing21154 -Node: Bug reports21443 -Node: Fixes and features22349 -Node: Coding style22832 -Node: Supporting mastodonel23456 -Node: Contributors23978 +Node: README962 +Node: Installation1378 +Node: ELPA1626 +Node: MELPA1854 +Node: repo2234 +Node: Emoji2727 +Node: Discover3058 +Node: Usage3610 +Node: Logging in to your instance4053 +Node: Timelines5050 +Ref: Keybindings5525 +Ref: Toot byline legend10098 +Node: Composing toots10407 +Ref: Keybindings (1)11646 +Ref: Autocompletion of mentions and tags12164 +Ref: Draft toots12877 +Node: Other commands and account settings13348 +Node: Customization16506 +Node: Commands and variables index17293 +Node: Alternative timeline layout17613 +Node: Live-updating timelines mastodon-async-mode18018 +Node: Translating toots18870 +Node: Bookmarks and mastodonel20052 +Node: Dependencies20524 +Node: Network compatibility21134 +Node: Contributing21620 +Node: Bug reports21909 +Node: Fixes and features22815 +Node: Coding style23298 +Node: Supporting mastodonel23922 +Node: Contributors24444 End Tag Table diff --git a/mastodon.texi b/mastodon.texi index 1f2cd14..46dc868 100644 --- a/mastodon.texi +++ b/mastodon.texi @@ -41,7 +41,9 @@ README Installation +* ELPA:: * MELPA:: +* repo:: * Emoji:: * Discover:: @@ -56,7 +58,7 @@ Usage * Alternative timeline layout:: * Live-updating timelines @samp{mastodon-async-mode}:: * Translating toots:: -* bookmarks and @samp{mastodon.el}: bookmarks and @samp{mastodonel}. +* Bookmarks and @samp{mastodon.el}: Bookmarks and @samp{mastodonel}. Contributing @@ -86,30 +88,25 @@ implement the Mastodon API@. For info see @uref{https://joinmastodon.org/, joinm @node Installation @section Installation -Clone this repository and add the lisp directory to your load path. -Then, require it and go. - -@lisp -(add-to-list 'load-path "/path/to/mastodon.el/lisp") -(require 'mastodon) -@end lisp - -Or, with @samp{use-package}: - -@lisp -(use-package mastodon - :ensure t) -@end lisp - -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. +You can install @samp{mastodon.el} from ELPA, MELPA, or directly from this repo. @menu +* ELPA:: * MELPA:: +* repo:: * Emoji:: * Discover:: @end menu +@node ELPA +@subsection ELPA + +You should be able to directly install with: + +@samp{M-x package-refresh-contents RET} + +@samp{M-x package-install RET mastodon RET} + @node MELPA @subsection MELPA @@ -127,6 +124,27 @@ Update and install: @samp{M-x package-install RET mastodon RET} +@node repo +@subsection repo + +Clone this repository and add the lisp directory to your load path. +Then, require it and go. + +@lisp +(add-to-list 'load-path "/path/to/mastodon.el/lisp") +(require 'mastodon) +@end lisp + +Or, with @samp{use-package}: + +@lisp +(use-package mastodon + :ensure t) +@end lisp + +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. + @node Emoji @subsection Emoji @@ -168,7 +186,7 @@ Or, with @samp{use-package}: * Alternative timeline layout:: * Live-updating timelines @samp{mastodon-async-mode}:: * Translating toots:: -* bookmarks and @samp{mastodon.el}: bookmarks and @samp{mastodonel}. +* Bookmarks and @samp{mastodon.el}: Bookmarks and @samp{mastodonel}. @end menu @node Logging in to your instance @@ -646,8 +664,8 @@ to your translator function as its text argument. Here's what (message "No toot to translate?")))) @end lisp -@node bookmarks and @samp{mastodonel} -@subsection bookmarks and @samp{mastodon.el} +@node Bookmarks and @samp{mastodonel} +@subsection Bookmarks and @samp{mastodon.el} @samp{mastodon.el} doesn’t currently implement its own bookmark record and handler, which means that emacs bookmarks will not work as is. Until we implement them, @@ -662,11 +680,9 @@ Hard dependencies (should all install with @samp{mastodon.el}): @samp{request} (for uploading attachments), @uref{https://github.com/tkf/emacs-request, emacs-request} @item @samp{persist} for storing some settings across sessions -@item -@samp{ts} for poll relative expiry times @end itemize -Optional dependencies: +Optional dependencies (install yourself, @samp{mastodon.el} can use them): @itemize @item @samp{emojify} for inserting and viewing emojis |