[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/xkcd 046ad2c582 67/82: Add README.org
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/xkcd 046ad2c582 67/82: Add README.org |
Date: |
Mon, 12 Dec 2022 21:59:54 -0500 (EST) |
branch: elpa/xkcd
commit 046ad2c5828132ee2ecb63d23bae5cea9a02beda
Author: Vibhav Pant <vibhavp@gmail.com>
Commit: Vibhav Pant <vibhavp@gmail.com>
Add README.org
---
README.org | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 51 insertions(+)
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..b2d2828cd3
--- /dev/null
+++ b/README.org
@@ -0,0 +1,51 @@
+#+TITLE: emacs-xkcd
+#+STARTUP: inlineimages
+
+[[https://travis-ci.org/vibhavp/emacs-xkcd][https://travis-ci.org/vibhavp/emacs-xkcd.png]]
+
+Implementation of an [[https://xkcd.com][xkcd]] reader for GNU Emacs.
+
+* Installation
+** Via package.el:
+ emacs-xkcd is available on [[http://melpa.milkbox.net][MELPA]] and
[[https://marmalade-repo.org/][Marmalade]]. Just add any
+ of these to your package archives, and install the package with
+ ~M-x package-install xkcd~.
+** Via Git
+ Clone this repo to a desired location, add the directory to your load path:
+ #+BEGIN_SRC lisp
+(add-to-list 'load-path (expand-file-name "/path/to/emacs-xkcd"))
+(require 'xkcd)
+ #+END_SRC
+
+* Screenshot:
+ [[./images/screenshot.png]]
+
+* Viewing comics:
+ + ~xkcd-get~ loads a user-specific xkcd.
+ Files are cached (for later offline viewing) by default to
~~/.emacs.d/xkcd/~.
+ This can be changed by changing ~xkcd-cache-dir~ in emacs-xkcd's customize
menu.
+ (~customize-group xkcd~)
+
+ + ~xkcd~ loads the latest xkcd.
+
+* Customization
+
+ emacs-xkcd can be customized with ~M-x customize-group xkcd~.
+ | Option | Use
| Default value |
+
|---------------------+------------------------------------------------------+--------------------------|
+ | ~xkcd-cache-dir~ | Directory where images and json files are cached
| ~~/.emacs.d/xkcd/~ |
+ | ~xkcd-cache-latest~ | File where the latest cached xkcd's number is stored
| ~~/.emacs.d/xkcd/latest~ |
+
+* Keybindings:
+
+ | Keybinding | Use | Function |
+ |------------+---------------------------------+-----------------|
+ | =r= | Load a random xkcd | (xkcd-rand) |
+ | =t= | Show alt-text in the minibuffer | (xkcd-alt-text) |
+ | =<right>= | Load next xkcd | (xkcd-next) |
+ | =<left>= | Loads previous xkcd | (xkcd-prev) |
+
+
+* Stuff yet to be added:
+** TODO View title in user-defined faces.
+** TODO Handle links to xkcd in Emacs with xkcd-get.
- [nongnu] elpa/xkcd 20e0b48044 42/82: Correct flycheck warnings, (continued)
- [nongnu] elpa/xkcd 20e0b48044 42/82: Correct flycheck warnings, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd f5942003bf 45/82: Fix xkcd-get-json, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 3c13ae29c4 49/82: Docstrings, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd e2daa08012 25/82: Add a better screenshot., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd df47be622f 28/82: The package isn't that hackish now., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd d1bc89dee2 34/82: Add variable xkcd-latest: Stores the latest cached xkcd number., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 7b1a312239 37/82: Add an help-echo text property to display the alt-text, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd e61b7e6ed6 51/82: xkcd-get-json: Get substring between (point) and (point-max), instead of, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 5693718f71 52/82: Add support for browse-url., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 0db98c2ca2 72/82: Add instructions for el-get., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 046ad2c582 67/82: Add README.org,
ELPA Syncer <=
- [nongnu] elpa/xkcd 7987d64a7e 71/82: * README.md: Remove. Replaced with README.org., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd b637a2aa84 13/82: Update README.md, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd b9095c5aae 16/82: Make xkcd-get-latest work., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 2da77a12e2 29/82: Provide xkcd instead of emacs-xkcd, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd e8bb80c4a0 30/82: Make comments work with Melpa., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd b303669b33 39/82: Merge pull request #7 from rafoo/master, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd ef6e51ade7 43/82: Code simplification, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd f2650dc392 46/82: Retrieve correct substring, ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 3304f05265 59/82: Autoload xkcd-handle-links., ELPA Syncer, 2022/12/12
- [nongnu] elpa/xkcd 60de549e25 63/82: Merge pull request #10 from heikkil/master, ELPA Syncer, 2022/12/12