[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/kiwix ad95e67 123/192: improve README
From: |
Stefan Monnier |
Subject: |
[elpa] externals/kiwix ad95e67 123/192: improve README |
Date: |
Sat, 19 Dec 2020 00:41:45 -0500 (EST) |
branch: externals/kiwix
commit ad95e6747258d6b9d035d468b01eabdfad6df61a
Author: stardiviner <numbchild@gmail.com>
Commit: stardiviner <numbchild@gmail.com>
improve README
---
README.org | 30 +++++++++++++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index 79bca25..ac217c3 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,11 @@
+* Intro
+
+This =kiwix.el= supports query =kiwix-tools='s =kiwix-serve= server through
URL API.
+
+The =kiwix-serve= server can be started from command-line if you have
kiwix-tools
+installed, or from Docker container [fn:1].
+
+
* How does this extension work?
** integrate with Emacs
@@ -61,11 +69,27 @@ with RESTful API.
- Or you can use other language to do this, like Ruby or Python etc.
+* Install
+
+** MELPA
+
+#+begin_src emacs-lisp :eval no
+(use-package kiwix
+ ;; :ensure t
+ :load-path "~/Code/Emacs/kiwix.el/"
+ :after org
+ :commands (kiwix-launch-server kiwix-at-point-interactive)
+ :bind (:map document-prefix ("w" . kiwix-at-point-interactive))
+ :init (setq kiwix-server-use-docker t
+ kiwix-server-url "http://127.0.0.1:8089/"
+ kiwix-default-library "wikipedia_zh_all_2015-11.zim"))
+#+end_src
+
* Usage
** Use in Emacs
-=[M-x kiwix-at-point]=
+=[M-x kiwix-at-point-interactive]=
** Org-mode integration
@@ -86,3 +110,7 @@ The =(library)= can be =wikipedia_en=, =wikipedia_zh=,
=wiktionary_en=, or =en=,
- [[wikipedia:Operations%20research][Operations research]] :: the second word
is not capitalized.
- [[wikipedia:%E4%B8%AD%E5%9B%BD][中国]] :: non-english query
- [[wikipedia:meta-circular%20interpreter][meta-circular interpreter]] :: only
capitalize the first word.
+
+* Footnotes
+
+[fn:1] https://github.com/kiwix/kiwix-tools/issues/257
- [elpa] externals/kiwix 86c6b1a 103/192: fix free variable link in function., (continued)
- [elpa] externals/kiwix 86c6b1a 103/192: fix free variable link in function., Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix a62f9e7 104/192: improve store link result., Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix c20df13 108/192: Put kiwix into a global-minor-mode, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 6d09e10 109/192: remove dangling parenthesis, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 170483a 111/192: fix kiwix-dir directory accessible unless logic, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 04bbaeb 115/192: add option to whether using kiwix-serve Docker container, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix d7549a3 118/192: update kiwix.el config example in comments, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 9c02ff5 120/192: rename kiwix-get-library-fullname -> kiwix-get-library-filename, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix dc72a3a 121/192: add wikipedia: Org Mode link by default now, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 954b9e4 122/192: use library name directly instead of complex library abbrev etc., Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix ad95e67 123/192: improve README,
Stefan Monnier <=
- [elpa] externals/kiwix 15a5c3c 124/192: make kiwix-serve server port customize option, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 7786e70 126/192: improve README: add Kiwix installation, kiwix-serve Docker setup., Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix e8bfe4e 127/192: update package description, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 2cec30b 132/192: add kiwix/kiwix-serve Docker image into installation section of README, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix c5b8f69 133/192: add a gender ping of kiwix-serve before query, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix d2ae338 130/192: fix org-link-set-parameters void function when package.el initialize., Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 04347e6 137/192: turn a request part into a separate function, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix f587833 135/192: make available testing before every query, Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 6c4d80a 136/192: fix `request' :error sentinel., Stefan Monnier, 2020/12/19
- [elpa] externals/kiwix 5221eda 142/192: silent request result, Stefan Monnier, 2020/12/19