[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/sweeprolog ccaa53a19c 147/166: DOC: update installation in
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/sweeprolog ccaa53a19c 147/166: DOC: update installation instruction to reflect inclusion in swipl |
Date: |
Fri, 30 Sep 2022 04:59:34 -0400 (EDT) |
branch: elpa/sweeprolog
commit ccaa53a19c0f17be9eefec50d91d7eac83013594
Author: Eshel Yaron <me@eshelyaron.com>
Commit: Eshel Yaron <me@eshelyaron.com>
DOC: update installation instruction to reflect inclusion in swipl
---
README.org | 28 ++++++++++++++++------------
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/README.org b/README.org
index eeb872d3f9..cdbbdc3709 100644
--- a/README.org
+++ b/README.org
@@ -35,10 +35,10 @@ advanced features for developing SWI-Prolog programs in
Emacs.
:CUSTOM_ID: high-level-architecture
:END:
-both SWI-Prolog and Emacs Lisp to create a dynamically loaded Emacs
-module that contains the SWI-Prolog runtime. As such, =sweep= has parts
-written in C, in Prolog and in Emacs Lisp.
-
+=sweep= uses the C interfaces of both SWI-Prolog and Emacs Lisp to
+create a dynamically loaded Emacs module that contains the SWI-Prolog
+runtime. As such, =sweep= has parts written in C, in Prolog and in
+Emacs Lisp.
The different parts of =sweep= are structured as follows:
@@ -68,30 +68,34 @@ The different parts of =sweep= are structured as follows:
:CUSTOM_ID: installation
:END:
+The dynamic Emacs module =sweep-module= and the Prolog helper library
+=sweep.pl= are included in the latest SWI-Prolog distribution. For
+instructions on how to build and install SWI-Prolog, see
+[[https://www.swi-prolog.org/build/]].
+
+To start using =sweep= in Emacs:
+
1. Clone the =sweep= repository:
#+begin_src sh
git clone https://git.sr.ht/~eshel/sweep
#+end_src
-2. Optionally, build the C module =sweep-module=:
+ Or:
+
#+begin_src sh
- cd sweep
- make
+ git clone https://github.com/SWI-Prolog/packages-sweep sweep
#+end_src
-3. Add =sweep= to Emacs' =load-path=:
+2. Add =sweep= to Emacs' =load-path=:
#+begin_src emacs-lisp
(add-to-list 'load-path "/path/to/sweep")
#+end_src
-4. Load =sweep= into Emacs:
+3. Load =sweep= into Emacs:
#+begin_src emacs-lisp
(require 'sweep)
#+end_src
- If =sweep-module= is not already built, =sweep= will suggest to build
- it when loaded.
-
* Prolog initialization and cleanup
:PROPERTIES:
:CUSTOM_ID: prolog-init
- [nongnu] elpa/sweeprolog 4b4b28f15a 007/166: Add module descriptions to sweep-find-module annotation function, (continued)
- [nongnu] elpa/sweeprolog 4b4b28f15a 007/166: Add module descriptions to sweep-find-module annotation function, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 0078ef8ff0 060/166: ENHANCED: syntax errors coloring, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog e38825d0e2 066/166: ENHANCED: use a distinct face for structured comments, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 84e6182685 077/166: FIXED: detect "|:" prompt in the top-level, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 6e5c822fc8 116/166: ADDED: sweep-colourise-buffer-on-idle user option, on by default, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog a7ce69558e 111/166: Makefile: Use "--batch" instead of "-batch" for consistency, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 5b54d23b8b 086/166: ENHANCED: apply an appropriate face to global predicate calls, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog d9b8ffccda 107/166: ADDED: (sweep-mode-map): bind C-c C-o to sweep-find-file-at-point, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog ecc36d67e1 089/166: FIXED: handle some missing color terms, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog f72ebe6d62 127/166: ENHANCHED: automatic syntax aware autoindentation in sweep-mode, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog ccaa53a19c 147/166: DOC: update installation instruction to reflect inclusion in swipl,
ELPA Syncer <=
- [nongnu] elpa/sweeprolog c8192b8c31 145/166: DOC: document imenu support in sweep-mode buffers, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 6b9e2a7833 139/166: Tweak README to prevent a hosting platform from failing to render it, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 79bf5b78b8 042/166: Run `make check` with libswipl preloaded, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 97440dda21 043/166: DOC: update the manual to reflect the latest GMP deconflication, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 9466ce0d59 046/166: ADDED: completion-at-point function in sweep-top-level-mode, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 6e9ac379e6 047/166: DOC: Expand top-level documentation section, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 4ecc8ec55f 050/166: Add BSD license, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog a26ca14c81 053/166: ENHANCED: show more relevant candidates in top-level completion, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog 7fa11fdcdd 055/166: FIXED: hide predicates starting with '$' in sweep-find-predicate, ELPA Syncer, 2022/09/30
- [nongnu] elpa/sweeprolog e70b4aef2f 057/166: ADDED: sweep-file-name-handler, ELPA Syncer, 2022/09/30