dickmao
/
nndiscourse
Protected
1
1
0
Fork 1
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity
A Gnus backend for Discourse
77 Commits
1 Branch
0 Tags
478 KiB
Emacs Lisp 90.4%
Makefile 4.2%
Ruby 3.4%
Shell 1.3%
Gherkin 0.7%
 
 
 
 
 
Go to file
madanyang 1c2f984597
Not nnhackernews 
The package is nndiscourse not nnhackernews, hence correcting the wording
 		2020-08-26 17:28:40 +02:00
.github/workflows dependabot insists on rack >= 2.1.4 2020-08-12 20:28:42 -04:00
features multiple servers, pull subcategories 2020-08-26 00:35:37 -04:00
nndiscourse dependabot insists on rack >= 2.1.4 2020-08-12 20:28:42 -04:00
tests ecukes 2020-02-11 16:11:17 -05:00
tools melpazoid package check got discontinued in ecc217439d 2020-04-17 14:34:05 -04:00
.gitignore melpazoid 2020-03-08 22:42:34 -04: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 multiple servers, pull subcategories 2020-08-26 00:35:37 -04:00
README.in.rst melpa badge 2020-08-26 07:51:50 -04:00
README.rst melpa badge 2020-08-26 07:51:50 -04:00
nndiscourse.el Not nnhackernews 2020-08-26 17:28:40 +02:00
scratch.el aborted defvoo craziness 2020-08-25 17:55:16 -04:00
screenshot.png readme 2020-02-12 00:40:19 -05:00

README.rst 

|build-status| |melpa-dev|

A Gnus backend for Discourse.

.. |build-status|
   image:: https://github.com/dickmao/nndiscourse/workflows/CI/badge.svg?branch=dev
   :target: https://github.com/dickmao/nndiscourse/actions
   :alt: Build Status
.. |melpa-dev|
   image:: https://melpa.org/packages/nndiscourse-badge.svg
   :target: http://melpa.org/#/nndiscourse
   :alt: MELPA current 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-install RET nndiscourse RET

You will also need Bundler_ for Ruby.

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
.. _Bundler: https://bundler.io