Merge pull request #1878 from zakkak/twitter-readme

app/twitter: add README.org
2019-10-12 23:52:53 -04:00 · 2019-10-12 23:52:53 -04:00 · a493200fbb
commit a493200fbb
parent 35db55d589 74211e11c0
1 changed files with 96 additions and 0 deletions
--- a/modules/app/twitter/README.org
+++ b/modules/app/twitter/README.org
@ -0,0 +1,96 @@
+#+TITLE:   app/twitter
+#+DATE:    October 11, 2019
+#+SINCE:   v2.0
+#+STARTUP: inlineimages
+
+* Table of Contents :TOC_3:noexport:
+- [[#description][Description]]
+  - [[#module-flags][Module Flags]]
+  - [[#plugins][Plugins]]
+  - [[#hacks][Hacks]]
+- [[#prerequisites][Prerequisites]]
+- [[#features][Features]]
+- [[#configuration][Configuration]]
+- [[#troubleshooting][Troubleshooting]]
+- [[#appendix][Appendix]]
+  - [[#commands--keybindings][Commands & Keybindings]]
+
+* Description
+Enjoy twitter from emacs.
+
+ View various timelines side by side, e.g. user's timeline, home, etc.
+ Post new tweets
+ Send direct messages
+ Retweet
+ Follow and un-follow users
+ Favorite tweets
+
+** Module Flags
+This module provides no flags.
+
+** Plugins
+ [[https://github.com/hayamiz/twittering-mode][twittering-mode]]
+ [[https://github.com/abo-abo/avy][avy]]
+
+** TODO Hacks
+{A list of internal modifications to included packages}
+
+* Prerequisites
+
+ For SSL connection (required by Twitter's API), one of the followings is required:
+  + [[http://curl.haxx.se/][cURL]]
+  + [[http://www.gnu.org/software/wget/][GNU Wget]]
+  + [[http://www.openssl.org/][OpenSSL]]
+  + [[http://www.gnu.org/software/gnutls/][GnuTLS]]
+ [[http://www.gnupg.org/][GnuPG]] is required for keeping the OAuth token encrypted in local storage.
+ ~twittering-icon-mode~ converts retrieved icons into XPM by default. To
+  achieve this and for displaying icons in formats that are not supported by
+  Emacs as well as for resizing icon images, [[http://www.imagemagick.org/][ImageMagick]] is required.
+
+  To build emacs with ImageMagick support the ~--with-imagemagick~ flag needs to
+  be passed to the ~configure~ script, e.g. ~./configure --with-imagemagick~.
+  For detailed instruction on how to build Emacs from source please refer to
+  [[https://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL][INSTALL]] in Emacs' savannah repository.
+ For keeping retrieved icons in local storage, [[http://www.gzip.org/][gzip]] is required.
+
+* TODO Features
+An in-depth list of features, how to use them, and their dependencies.
+
+* TODO Configuration
+How to configure this module, including common problems and how to address them.
+
+* Troubleshooting
+Currently ~twittering-mode~ binds =SPC=, breaking its functionality as a leader
+key. To work around this issue you may use =M-SPC= instead when in
+~twittering-mode~.
+
+* Appendix
+** Commands & Keybindings
+Here is a list of available commands and their default keybindings (defined in
+[[./config.el][config.el]]).
+
+| command             | key / ex command | description                                                 |
+|---------------------+------------------+-------------------------------------------------------------|
+| ~+twitter/quit~     | =q=              | Close current window                                        |
+| ~+twitter/quit-all~ | =Q=              | Close all twitter windows and buffers, and delete workspace |
+
+And when ~:editor evil +everywhere~ is active:
+
+| command                                          | key / ex command | description                                                      |
+|--------------------------------------------------+------------------+------------------------------------------------------------------|
+| ~twittering-favorite~                            | =f=              | Favorite/Like a tweet                                            |
+| ~twittering-unfavorite~                          | =F=              | Un-favorite/Un-like a tweet                                      |
+| ~twittering-follow~                              | =C-f=            | Follow user                                                      |
+| ~twittering-unfollow~                            | =C-F=            | Un-follow user                                                   |
+| ~twittering-delete-status~                       | =d=              | Delete a tweet                                                   |
+| ~twittering-retweet~                             | =r=              | Retweet                                                          |
+| ~twittering-toggle-or-retrieve-replied-statuses~ | =R=              | Toggle or retrieve replies                                       |
+| ~twittering-update-status-interactive~           | =o=              | Update tweets                                                    |
+| ~+twitter/ace-link~                              | =O=              | Open some visible link from a ~twittering-mode~ buffer using ace |
+| ~twittering-search~                              | =/=              | Search                                                           |
+| ~twittering-goto-next-status~                    | =J=              | Go to next tweet                                                 |
+| ~twittering-goto-previous-status~                | =K=              | Go to previous tweet                                             |
+| ~twittering-goto-first-status~                   | =gg=             | Go to first tweet                                                |
+| ~twittering-goto-last-status~                    | =G=              | Go to last tweet                                                 |
+| ~twittering-goto-next-status-of-user~            | =gj=             | Go to next tweet of user                                         |
+| ~twittering-goto-previous-status-of-user)))~     | =gk=             | Go to previous tweet of user                                     |