nnreddit/README.rst

56 lines
1.7 KiB
ReStructuredText

==============
|build-status|
==============
A Gnus backend for Reddit.
.. |build-status|
image:: https://travis-ci.org/dickmao/nnreddit.svg?branch=master
:target: https://travis-ci.org/dickmao/nnreddit
:alt: Build Status
.. |melpa-dev|
image:: http://melpa.milkbox.net/packages/ein-badge.svg
:target: http://melpa.milkbox.net/#/ein
:alt: MELPA development version
.. |melpa-stable|
image:: http://melpa-stable.milkbox.net/packages/ein-badge.svg
:target: http://melpa-stable.milkbox.net/#/ein
:alt: MELPA stable version
Install
=======
``make install`` from github source.
Usage
=====
In your ``.gnus`` or ``.emacs``,
::
(add-to-list 'gnus-secondary-select-methods
'(nnreddit ""))
A typical session might look like::
M-x gnus
R g emacsy
q
u
Keybinding ``u`` (gnus-group-unsubscribe-current-group) actually *toggles* subscription to ``r/emacsy``. I don't make the rules.
Reenter the ``emacsy`` newsgroup with ``RET``. Rapidly catch yourself up via ``N`` and ``P``. Instantly catch-up with ``c``, and worry not. If a thread was important, it will show up again.
Create a post via ``a``.
Reply to articles with ``f`` or ``r``. Include original with ``F``.
Vote articles by first entering the Article buffer, then ``R -`` (down), ``R =`` (up), or ``R 0`` (retract).
From the ``*Group*`` buffer, press ``g`` to refresh all subreddits. ``M-g`` on a particular subreddit to refresh individually.
Gnus beginners may find the interface bewildering. In particular, subreddits with no unread articles do not display. Use ``L`` to bring them out of hiding.
.. _Cask: https://cask.readthedocs.io/en/latest/guide/installation.html
.. _MELPA: http://melpa.org/#/