nndiscourse

A Gnus backend for Discourse

Go to file

dickmao e22fa8f45d apprise encoding of charset utf-8		2020-02-25 10:43:25 -05:00
.github/workflows	no more rbenv	2020-02-11 23:55:03 -05:00
features	conditionally apply test	2020-02-24 06:50:31 -05:00
nndiscourse	test machinery	2020-02-11 14:00:21 -05:00
tests	ecukes	2020-02-11 16:11:17 -05:00
tools	elpa keys	2020-02-24 07:05:29 -05:00
.gitignore	nndiscourse-retrieve-groups contortions	2020-02-10 16:12:31 -05:00
Cask	before splitting headers back by group	2020-02-04 10:27:20 -05:00
LICENSE	Initial commit	2019-08-28 14:23:08 -04:00
Makefile	missing message-encode-message-body	2020-02-21 09:36:36 -05:00
README.in.rst	readme [skip ci]	2020-02-17 06:44:56 -05:00
README.rst	readme [skip ci]	2020-02-17 06:44:56 -05:00
nndiscourse.el	apprise encoding of charset utf-8	2020-02-25 10:43:25 -05:00
scratch.el	Do not skip mml step (else contaminate future mml-parses)	2020-02-24 06:45:22 -05:00
screenshot.png	readme	2020-02-12 00:40:19 -05:00

README.rst

|build-status|

A Gnus backend for Discourse.

.. |build-status|
   image:: https://github.com/dickmao/nndiscourse/workflows/CI/badge.svg
   :target: https://github.com/dickmao/nndiscourse/actions
   :alt: Build Status
.. |melpa-dev|
   image:: http://melpa.milkbox.net/packages/nndiscourse-badge.svg
   :target: http://melpa.milkbox.net/#/nndiscourse
   :alt: MELPA development version

.. image:: screenshot.png
.. |--| unicode:: U+2013   .. en dash
.. |---| unicode:: U+2014  .. em dash, trimming surrounding whitespace
   :trim:

Install
=======
As described in `Getting started`_, ensure melpa's whereabouts in ``init.el`` or ``.emacs``::

   (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/"))

Then

::

   M-x package-refresh-contents RET
   M-x package-initialize RET
   M-x package-install RET nndiscourse RET

Alternatively, directly clone this repo and ``make install``.

Also see Troubleshooting_.

Usage
=====
Suppose you want to follow https://emacs-china.org.  In your ``.emacs`` or ``init.el``, use ONE of the following:

::

   ;; Applies to first-time Gnus users
   (custom-set-variables '(gnus-select-method
       (quote (nndiscourse "emacs-china.org" (nndiscourse-scheme "https")))))

or, if you're an existing Gnus user,

::

   ;; Applies to existing Gnus users
   (add-to-list 'gnus-secondary-select-methods
       (quote (nndiscourse "emacs-china.org" (nndiscourse-scheme "https"))))

Then ``M-x gnus``.

Select a topic category via ``RET``.  Rapidly catch yourself up via ``N`` and ``P``.  Instantly catch-up with ``c``.

From the ``*Group*`` buffer, press ``g`` to refresh all categories.  ``M-g`` on a particular category to refresh individually.

From the summary buffer, ``/o`` redisplays posts already read.  ``x`` undisplays them.

Gnus beginners may find the interface bewildering.  In particular, categories with no unread posts do not display.  Use ``L`` to bring them out of hiding.

Troubleshooting
===============
Clone this repo.  Then install Cask_.  Then try ``make test-run-interactive``.

.. _Cask: https://cask.readthedocs.io/en/latest/guide/installation.html
.. _Getting started: http://melpa.org/#/getting-started