[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/geiser-kawa 322a40f 093/119: README.org: add heading about
From: |
Philip Kaludercic |
Subject: |
[nongnu] elpa/geiser-kawa 322a40f 093/119: README.org: add heading about manual lookup |
Date: |
Sun, 1 Aug 2021 18:30:45 -0400 (EDT) |
branch: elpa/geiser-kawa
commit 322a40f1fd83b4e5ea83e70b4893d5ca1a01ce0e
Author: spellcard199 <spellcard199@protonmail.com>
Commit: spellcard199 <spellcard199@protonmail.com>
README.org: add heading about manual lookup
---
README.org | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/README.org b/README.org
index cf81eae..2f96f03 100644
--- a/README.org
+++ b/README.org
@@ -63,6 +63,12 @@ To try geiser-kawa you need neither Maven nor Kawa:
- =mvnw= ([[https://github.com/takari/maven-wrapper][maven-wrapper]]) takes
care of downloading a project-specific Maven version
- kawa-geiser has [[https://gitlab.com/groups/kashell/][Kawa's master branch]]
as one of its dependencies. When =quickstart.el= calls =./mvnw package=
(wrapped by =geiser-kawa-deps-mvnw-package=), it produces a jar that includes
kawa-geiser and all its dependencies, including Kawa itself.
+** About manual lookup
+
+To use the =geiser-doc-lookup-manual= feature you need a copy of the Kawa
manual. You can either compile it from the Kawa source code or extract it from
the pre-compiled Kawa release available on the Kawa website:
https://www.gnu.org/software/kawa/Getting-Kawa.html.
+
+Once you have the manual in either .info or .epub format, set the
=geiser-kawa-manual-path= elisp variable to the path of the file.
+
** About Autodoc
Double quotes around parameters: the reason why the arguments are enclosed in
double quotes in autodoc is because special characters (e.g. =]=) aren't read
as part of a symbol by the elisp reader that geiser relies on to display
autodoc data. To work-around this limitation parameters are represented by
using strings instead of symbols.
- [nongnu] elpa/geiser-kawa 45dc276 060/119: Fix and set pretty print default to true, (continued)
- [nongnu] elpa/geiser-kawa 45dc276 060/119: Fix and set pretty print default to true, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa f9149a7 074/119: Move elisp tests under the elisp directory, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa e349b4b 079/119: Refactor+Fix+Style: many changes in preparation for melpa submission., Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa ca594ec 075/119: Refactor: rename some functions, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 32c0359 085/119: Update kawa-devutil version, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa c1f9e3f 087/119: Fix unsupported add to gnu.lists.EmptyList, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 1e15f01 091/119: Refactor 'geiser-kawa-util--eval...' + related fixes, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa e864cf6 108/119: Fix docstring wording, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 46ab237 102/119: melpa/melpa#6858 - Replace license boilerplates with SPDX-License-Identifier, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 506bf81 095/119: Add section about embedding kawa-geiser in a java application, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 322a40f 093/119: README.org: add heading about manual lookup,
Philip Kaludercic <=
- [nongnu] elpa/geiser-kawa 6009d95 100/119: Rename test-geiser-kawa.el to geiser-kawa-test.el + fix flycheck issues, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa cd39deb 116/119: Update geiser version in Package-Requires, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 989485b 118/119: README.org - update instructions with new geiser-kawa's repo, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 3d999a3 119/119: README.org - update Geiser's repo url after new repo, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 02cd922 046/119: Add workaround to free port when a Kawa server is already using it through ssocket.close(), Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 0d86c7b 048/119: Add java package completion caching at module load time, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 6ff146d 077/119: pom.xml: update kawa-devutil version, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa e63a8b4 088/119: Improve message when manual is not found., Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa 47f195f 094/119: README.org: add heading about extending geiser-kawa, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-kawa b96c008 113/119: pom.xml - update kawa-devutil version, Philip Kaludercic, 2021/08/01